Skip to main content

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

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

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

Для поиска пользователя передайте один из ниже перечисленных параметров
Поиск осуществляется по логину (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": 1683,
      "createdAt": "2026-07-02T11:15:46.896Z",
      "updatedAt": "2026-07-02T11:15:46.940Z",
      "archivedAt": null,
      "uuid": "e-cjTT0CWMCB",
      "active": true,
      "activated": true,
      "banned": false,
      "alive": true,
      "domain": "id1683",
      "email": "[email protected]",
      "phone": "+9876543210",
      "tgId": 987654321,
      "vkId": null,
      "appleId": null,
      "extId": "crm_12345",
      "schoolId": 198,
      "language": "Uz",
      "timezone": 5,
      "lastOnlineAt": "2026-07-02T10:36:11.446Z",
      "starsBalance": 0,
      "currentTime": "2026-07-02T11:15:46+00:00",
      "isSleepingNow": false,
      "profile": {
        "id": 1665,
        "createdAt": "2026-07-02T11:15:46.932Z",
        "updatedAt": "2026-07-02T11:15:46.932Z",
        "archivedAt": null,
        "userId": 1683,
        "official": false,
        "firstName": "Firstname",
        "lastName": "Lastname",
        "fullName": "Firstname Lastname",
        "fullNameShort": "Firstname L.",
        "bdate": null,
        "sex": "Ufo",
        "country": null,
        "city": null,
        "role": "Student",
        "status": null,
        "title": "",
        "emojiTitle": "",
        "avatar": {
          "id": 1665,
          "small": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/small/avatar.png",
          "medium": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/medium/avatar.png",
          "maximum": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/avatar.png"
        },
        "titleState": {
          "manualTitle": null,
          "manualEmojiTitle": null,
          "manualNextTitle": null,
          "manualNextEmojiTitle": null,
          "manualExpiredAt": null,
          "locationTitle": null,
          "locationEmojiTitle": null,
          "achievementTitle": null,
          "achievementEmojiTitle": null
        }
      }
    }
  }
}

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

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