Skip to main content

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

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

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

​
Пагинация

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

​
Фильтрация

​
courseIds
integer[]
Фильтр по ID курсов.
​
aliases
string[]
Фильтр по символьным алиасам курсов.
​
types
enum[]
Фильтр по типам курсов. Возможные значения: Bundle, Webinar, TextCourse, Assessment, VideoCourse, PersonalLesson.
​
tags
string[]
Фильтр по тегам курса. До 50 символов на тег.
​
search
string
Поиск по названию курса. Максимум 50 символов.
​
subjectCategoryIds
integer[]
Фильтр по ID предметных категорий.
​
contentCategoryIds
integer[]
Фильтр по ID контентных категорий.
​
archived
boolean
Включить архивные курсы.
​
participation
enum
Тип участия (относительно текущего сервисного пользователя): All, Active, Completed, NotParticipant.
​
manage
boolean
Только курсы, доступные на управление.
​
administrate
boolean
Только курсы, доступные на администрирование.
​
access
object
Вложенный фильтр по доступам к продукту курса. Полный набор полей совпадает с фильтром метода «Список доступов к продуктам» (например, active, userIds, billingStatuses, expireAtDateRange).
​
product
object
Вложенный фильтр по продукту.

​
Поля ответа

​
payload
object
Постраничный список курсов (компактная проекция). Полная структура — в справочнике course.
curl --location 'https://api.exode.biz/saas/v2/course/list/raw?take=20&types=VideoCourse' \
  --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": [
      {
        "courseId": 10,
        "productId": 838,
        "name": "Подготовка к экзамену",
        "type": "VideoCourse",
        "groupIds": [
          501,
          502
        ]
      }
    ],
    "next": {
      "skip": 20,
      "take": 20,
      "page": 2
    },
    "prev": {
      "skip": 0,
      "take": 20,
      "page": 1
    }
  }
}

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

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