Заголовки запроса
string
обязательно
API-токен сервисного пользователя в формате
Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете:
Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».integer
обязательно
Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в
карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
integer
обязательно
Числовой ID школы, берётся там же, где
Seller-Id. Значение должно совпадать со школой продавца — иначе
вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".SchoolManageUsers).
Все параметры фильтрации необязательны. Без фильтров метод вернёт всех пользователей школы с учётом
пагинации. Каждый элемент ответа — объект
userWithProfile (пользователь с вложенным профилем).Параметры-массивы передаются повторением параметра:
statuses=Active&statuses=OnLeave. Диапазоны дат —
вложенными полями: createdAtDateRange[from]=2026-01-01&createdAtDateRange[to]=2026-02-01.Параметры запроса
Пагинация
integer
Количество записей на странице. От
1 до 1000. По умолчанию 100.integer
Номер страницы (начиная с
1). Альтернатива skip.integer
Количество записей, которые нужно пропустить. По умолчанию
0.Фильтрация
string
Поиск по имени, фамилии, email, телефону и доменному логину. Максимум 50 символов.
enum[]
Фильтр по статусам учётной записи:
Active, OnLeave, Banned, Blocked, Terminated, Deleted.
Описание статусов — в справочнике user.boolean
Фильтр по признаку подтверждённого входа (
true/false).boolean
Фильтр по архивности:
true — только архивированные, false — только неархивированные.integer[]
Фильтр по ID пользователей.
string[]
Фильтр по внешним идентификаторам из вашей системы. От 1 до 50 символов каждый, максимум 250 элементов.
object
Диапазон даты создания:
createdAtDateRange[from], createdAtDateRange[to] (ISO 8601).object
Диапазон последней активности:
lastOnlineAtDateRange[from], lastOnlineAtDateRange[to] (ISO 8601).object
Фильтр по UTM-меткам регистрации. Поле
value — массив пар { key, value } (непустые строки).object
Диапазон даты архивации (удаления):
archivedAtDateRange[from], archivedAtDateRange[to] (ISO 8601).integer[]
Фильтр по ID пользователей, выполнивших архивацию (удаление).
object
Вложенный фильтр по профилю.
Сортировка
enum
Сортировка по ID:
ASC или DESC.enum
Сортировка по дате создания:
ASC или DESC.enum
Сортировка по последней активности:
ASC или DESC.enum
Сортировка по дате обновления:
ASC или DESC.enum
Сортировка по балансу «звёзд»:
ASC или DESC.enum
Сортировка по количеству доступов к продуктам:
ASC или DESC.enum
Сортировка по дате архивации:
ASC или DESC.enum
Сортировка по внутреннему порядку:
ASC или DESC.Поля ответа
Требования к правам доступа
Требуется аутентификация по токену и право «Управление пользователями школы» (
SchoolManageUsers).Обновлено: 2026-09-25 13:43 UTC