Заголовки запроса
API-токен сервисного пользователя в формате
Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете:
Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в
карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
Числовой ID школы, берётся там же, где
Seller-Id. Значение должно совпадать со школой продавца — иначе
вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".SchoolManageUsers).
Все параметры фильтрации необязательны. Без фильтров метод вернёт всех пользователей школы с учётом
пагинации. Каждый элемент ответа — объект
userWithProfile (пользователь с вложенным профилем).Параметры-массивы передаются повторением параметра:
statuses=Active&statuses=OnLeave. Диапазоны дат —
вложенными полями: createdAtDateRange[from]=2026-01-01&createdAtDateRange[to]=2026-02-01.Параметры запроса
Пагинация
Фильтрация
Искать
search только в одном поле: Id (точное совпадение, можно id123), Phone (цифры номера в любой
его части), Email (любая часть адреса), Name (имя и фамилия в любом порядке), Login (доменный логин),
TgId (точное совпадение). Не передан — поиск идёт по всем полям сразу.Фильтр по статусам учётной записи:
Active, OnLeave, Banned, Blocked, Terminated, Deleted.
Описание статусов — в справочнике user.Фильтр по внешним идентификаторам из вашей системы. От 1 до 50 символов каждый, максимум 250 элементов.
Диапазон последней активности:
lastOnlineAtDateRange[from], lastOnlineAtDateRange[to] (ISO 8601).Диапазон даты архивации (удаления):
archivedAtDateRange[from], archivedAtDateRange[to] (ISO 8601).Только сотрудники с активной занятостью в указанных подразделениях
или в любом из их дочерних подразделений. Для школ сегмента
Corporate.Только сотрудники с активной занятостью на указанных должностях. Для школ
сегмента
Corporate.Диапазон количества активных доступов к продуктам:
productAccessesCountRange[from],
productAccessesCountRange[to] (числа, границы включительно; можно передать одну из границ).То же, что
productAccessesCountRange, но учитываются только оплаченные доступы:
productAccessesPurchasedCountRange[from], productAccessesPurchasedCountRange[to].Сортировка
Поля ответа
Постраничный список пользователей. Структура элемента — в справочнике
user.Требования к правам доступа
Требуется аутентификация по токену и право «Управление пользователями школы» (
SchoolManageUsers).Обновлено: 2026-10-16 13:24 UTC