Find by identifier

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'

const axios = require('axios');

const findUser = async () => {
  try {
    const response = await axios.get('https://api.exode.biz/saas/v2/user/find', {
      params: { extId: 'crm_12345' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    });

    console.log('User found:', response.data.payload);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

findUser();

<?php

$url = 'https://api.exode.biz/saas/v2/user/find';
$params = [ 'extId' => 'crm_12345' ];

$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
  $result = json_decode($response, true);
  if ($result['payload']) {
    echo "User found successfully\n";
    print_r($result['payload']);
  } else {
    echo "User not found\n";
  }
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/user/find'

params = { 'extId': 'crm_12345' }

headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Authorization': 'Bearer YOUR_TOKEN'
}

try:
  response = requests.get(url, params=params, headers=headers)
  response.raise_for_status()

  result = response.json()
  if result['payload']:
    print('User found successfully:')
    print(json.dumps(result['payload'], indent=2, ensure_ascii=False))
  else:
    print('User not found')

except requests.exceptions.RequestException as e:
  print(f'Error: {e}')
  if hasattr(e, 'response') and e.response is not None:
    print(f'Response: {e.response.text}')

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/find?extId=crm_12345");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");

Ответ = Соединение.ВызватьHTTPМетод("GET", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("User found");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "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,
      "status": "Active",
      "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
        }
      }
    }
  }
}

{
  "success": true,
  "code": 200,
  "payload": {
    "user": null
  }
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "login must be longer than or equal to 2 characters"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "tgId must be an integer number"
  ],
  "error": "Bad Request"
}

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'

const axios = require('axios');

const findUser = async () => {
  try {
    const response = await axios.get('https://api.exode.biz/saas/v2/user/find', {
      params: { extId: 'crm_12345' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    });

    console.log('User found:', response.data.payload);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

findUser();

<?php

$url = 'https://api.exode.biz/saas/v2/user/find';
$params = [ 'extId' => 'crm_12345' ];

$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
  $result = json_decode($response, true);
  if ($result['payload']) {
    echo "User found successfully\n";
    print_r($result['payload']);
  } else {
    echo "User not found\n";
  }
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/user/find'

params = { 'extId': 'crm_12345' }

headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Authorization': 'Bearer YOUR_TOKEN'
}

try:
  response = requests.get(url, params=params, headers=headers)
  response.raise_for_status()

  result = response.json()
  if result['payload']:
    print('User found successfully:')
    print(json.dumps(result['payload'], indent=2, ensure_ascii=False))
  else:
    print('User not found')

except requests.exceptions.RequestException as e:
  print(f'Error: {e}')
  if hasattr(e, 'response') and e.response is not None:
    print(f'Response: {e.response.text}')

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/find?extId=crm_12345");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");

Ответ = Соединение.ВызватьHTTPМетод("GET", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("User found");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "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,
      "status": "Active",
      "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
        }
      }
    }
  }
}

{
  "success": true,
  "code": 200,
  "payload": {
    "user": null
  }
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "login must be longer than or equal to 2 characters"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "tgId must be an integer number"
  ],
  "error": "Bad Request"
}

Request headers

string

required

The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.

integer

required

The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.

integer

required

The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.

GET /saas/v2/user/find

Requires authentication and the “School User Management” permission (SchoolManageUsers).

To find several users at once, use Find by a list of identifiers.

Query parameters

To find a user, pass one of the parameters listed below

The search is performed by login (email/phone/domain), then by Telegram ID, then by the external identifier extId. If several parameters are passed, they are checked in order login → tgId → extId, and the first user found is returned: for example, if no one matches login, the search continues by tgId. If no user is found by any parameter, user: null is returned (this is not an error; the response code is 200).

User login, 2 to 50 characters. It can be an email address, a phone number in international format or a domain login (domain) — by default it looks like id12345, but a custom one can be set when creating/updating the user. The value is passed in the query string, so encode it (encodeURIComponent): without encoding, the + sign in a phone number turns into a space — pass %2B9876543210.

integer

The user’s Telegram ID. An integer.

string

The user’s external identifier from your system (1 to 50 characters) — the value passed in extId when creating or updating the user.

A user’s login can be:

An email address (for example: [email protected])
A phone number in international format (for example: +9876543210)
The user’s domain (for example, id12345)

You must pass at least one of the parameters. Check order: login → tgId → extId — the first user found is returned.

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'

const axios = require('axios');

const findUser = async () => {
  try {
    const response = await axios.get('https://api.exode.biz/saas/v2/user/find', {
      params: { extId: 'crm_12345' },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    });

    console.log('User found:', response.data.payload);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

findUser();

<?php

$url = 'https://api.exode.biz/saas/v2/user/find';
$params = [ 'extId' => 'crm_12345' ];

$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
  $result = json_decode($response, true);
  if ($result['payload']) {
    echo "User found successfully\n";
    print_r($result['payload']);
  } else {
    echo "User not found\n";
  }
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/user/find'

params = { 'extId': 'crm_12345' }

headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Authorization': 'Bearer YOUR_TOKEN'
}

try:
  response = requests.get(url, params=params, headers=headers)
  response.raise_for_status()

  result = response.json()
  if result['payload']:
    print('User found successfully:')
    print(json.dumps(result['payload'], indent=2, ensure_ascii=False))
  else:
    print('User not found')

except requests.exceptions.RequestException as e:
  print(f'Error: {e}')
  if hasattr(e, 'response') and e.response is not None:
    print(f'Response: {e.response.text}')

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/find?extId=crm_12345");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");

Ответ = Соединение.ВызватьHTTPМетод("GET", Запрос);

Если Ответ.КодСостояния = 200 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("User found");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "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,
      "status": "Active",
      "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
        }
      }
    }
  }
}

{
  "success": true,
  "code": 200,
  "payload": {
    "user": null
  }
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "login must be longer than or equal to 2 characters"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "tgId must be an integer number"
  ],
  "error": "Bad Request"
}

Permission requirements

Finding a user requires the “School User Management” permission (SchoolManageUsers).

The service user must be authenticated by token and have the appropriate access permissions for the specified school.

The search is performed only within the specified school. Users from other schools will not be found.

Updated: 2026-09-25 14:33 UTC

Working with the API

Users

Staff (HR)

Groups

Courses

Access and sales

Reports and exports

Custom fields

Forms

Missing a method?

All objects

Request headers

Query parameters

To find a user, pass one of the parameters listed below

Permission requirements

​Request headers

​Query parameters

To find a user, pass one of the parameters listed below

​Permission requirements

Request headers

Query parameters

Permission requirements