Skip to main content

​
Заголовки запроса

​
Authorization
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
​
Seller-Id
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
​
School-Id
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

​
Параметры запроса

Для поиска пользователя передайте один из ниже перечисленных параметров
Поиск осуществляется по логину (email/телефон/домен), затем по Telegram ID, затем по внешнему идентификатору extId. Приоритет: login → tgId → extId. Если пользователь не найден — возвращается null. Если переданы несколько параметров — используется параметр с наивысшим приоритетом.
​
login
string
Логин пользователя. Может быть email адресом, номером телефона в международном формате или id12345... — если вы знаете ID пользователя в системе exode.
​
tgId
integer
Telegram ID пользователя. Целое число.
​
extId
string
Внешний идентификатор пользователя из вашей системы.
Логином пользователя может быть:
  • Email адрес (например: [email protected])
  • Номер телефона в международном формате (например: +9876543210)
  • Домен пользователя (например, id12345)
Необходимо передать хотя бы один из параметров. Приоритет выбора: login → tgId → extId. Если указаны все три — будет использован login.
curl --location --request GET 'https://api.exode.biz/saas/v2/user/find?extId=crm_12345' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "code": 200,
  "payload": {
    "user": {
      "id": 27,
      "createdAt": "2024-08-09T14:08:12.641Z",
      "updatedAt": "2024-08-20T13:36:11.456Z",
      "deletedAt": null,
      "archivedAt": null,
      "uuid": "kCJG2XswaaIv",
      "active": true,
      "activated": true,
      "banned": false,
      "tgId": 987654321,
      "email": "[email protected]",
      "phone": null,
      "permissions": [],
      "language": "Uz",
      "timezone": 5,
      "lastOnlineAt": "2024-08-20T13:36:11.446Z",
      "starsBalance": 0,
      "currentTime": "2025-07-20T10:37:39-05:00",
      "isSleepingNow": false
    }
  }
}

​
Требования к правам доступа

Для поиска пользователя требуется право на управление пользователями школы.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.
Поиск осуществляется только в рамках указанной школы. Пользователи из других школ не будут найдены.