Skip to main content

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

​
Authorization
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
​
Seller-Id
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
​
School-Id
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
GET /saas/v2/group/list/raw
Все параметры фильтрации необязательны. Если не передать ни одного фильтра — будут возвращены все группы школы с учётом пагинации.
Параметры-массивы передаются повторением параметра в строке запроса: groupIds=1&groupIds=2&groupIds=3.

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

​
Пагинация

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

​
Фильтрация

​
groupIds
integer[]
Фильтр по ID групп.
​
productIds
integer[]
Фильтр по ID продуктов, к которым привязаны группы.
​
courseIds
integer[]
Фильтр по ID курсов.
​
search
string
Поиск по названию группы. Максимум 50 символов.

​
Поля ответа

​
payload
object
Постраничный список групп (компактная проекция). Полная структура — в справочнике group.
curl --location 'https://api.exode.biz/saas/v2/group/list/raw?take=20&courseIds=10' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "code": 200,
  "payload": {
    "page": 1,
    "count": 1,
    "pages": 1,
    "isFirst": true,
    "isLast": true,
    "items": [
      {
        "groupId": 501,
        "name": "Поток №1",
        "courseId": 10,
        "courseName": "Подготовка к экзамену",
        "membersCount": 42
      }
    ],
    "next": {
      "skip": 20,
      "take": 20,
      "page": 2
    },
    "prev": {
      "skip": 0,
      "take": 20,
      "page": 1
    }
  }
}

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

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