Группы

Метод возвращает каталог активных групп вашей компании. Состав дополнительных данных зависит от выданных разрешений.

Запрос

GET /api/v2/groups
Scope: groups:read

Фильтры

Параметр	Назначение
branch_id	Идентификатор филиала.
school_id	Идентификатор школы внутри экземпляра CRM.
school_external_id	Внешний стабильный идентификатор школы.
school_name	Точное название школы.
campus	Название корпуса или филиала.
level	Название уровня.
school_class	Класс от 1 до 11. Фильтрация выполняется через настройки уровня или группы.
formats[]	online, offline или hybrid.
days[]	Дни недели от 1 (понедельник) до 7 (воскресенье).
page, per_page	Пагинация.

Пример

GET /api/v2/groups?school_external_id=school-001&school_class=4&formats[]=offline

В поле capacity возвращаются текущая численность, лимит, свободные места и признак заполненной группы. Поле schedule возвращается с правом schedule:read, prices - с groups:prices:read, teacher - с groups:teachers:read. Эти права нужно выбрать в подключении и запросить при получении токена. Внутренний комментарий группы не используется как описание в новых подключениях.