Skip to main content

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

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

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

Пагинация

integer
Количество записей, которые нужно пропустить. По умолчанию 0.
integer
Номер страницы (альтернатива skip). Начинается с 1.
integer
Количество записей на странице. От 1 до 1000. По умолчанию 100.

Фильтрация

integer[]
Фильтр по ID групп.
integer[]
Фильтр по ID пользователей-участников.
integer[]
Фильтр по ID записей участников.
integer[]
Фильтр по ID пригласивших пользователей.
integer[]
Фильтр по ID продуктов, к которым привязаны группы.
boolean
Фильтр по активности участника в группе.
Поиск по логину (email, телефон) и имени участника. Максимум 50 символов.
object
Диапазон даты добавления в группу.

Поля ответа

object
Постраничный список участников групп. Базовая структура участника — в справочнике groupMember, пользователя — в справочнике user.

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

Требуется аутентификация по токену и право «Управление пользователями школы» (SchoolManageUsers).

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