Skip to main content

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

string
обязательно
API-токен сервисного пользователя в формате Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете: Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».
integer
обязательно
Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
integer
обязательно
Числовой ID школы, берётся там же, где Seller-Id. Значение должно совпадать со школой продавца — иначе вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".
Требуется аутентификация и право «Управление пользователями школы» (SchoolManageUsers).
Нужно найти сразу несколько пользователей — используйте Поиск списком идентификаторов.

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

Для поиска пользователя передайте один из ниже перечисленных параметров
Поиск осуществляется по логину (email/телефон/домен), затем по Telegram ID, затем по внешнему идентификатору extId. Если передано несколько параметров, они проверяются по очереди login → tgId → extId, и возвращается первый найденный пользователь: например, если по login никого нет, поиск продолжится по tgId. Если пользователь не найден ни по одному параметру — возвращается user: null (это не ошибка, код ответа 200).
string
Логин пользователя, от 2 до 50 символов. Может быть email адресом, номером телефона в международном формате или доменным логином (domain) — по умолчанию он имеет вид id12345, но может быть задан свой при создании/обновлении пользователя. Значение передаётся в query-строке, поэтому кодируйте его (encodeURIComponent): знак + в телефоне без кодирования превращается в пробел — передавайте %2B9876543210.
integer
Telegram ID пользователя. Целое число.
string
Внешний идентификатор пользователя из вашей системы (от 1 до 50 символов) — значение, переданное в extId при создании или обновлении пользователя.
Логином пользователя может быть:
  • Email адрес (например: [email protected])
  • Номер телефона в международном формате (например: +9876543210)
  • Домен пользователя (например, id12345)
Необходимо передать хотя бы один из параметров. Порядок проверки: login → tgId → extId — возвращается первый найденный пользователь.

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

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

Обновлено: 2026-09-25 13:43 UTC