Skip to main content

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

string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
Возвращает доступы пользователей к продуктам школы. Все параметры фильтрации необязательны. Параметры-массивы передаются повторением параметра: userIds=1&userIds=2.

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

Пагинация

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

Фильтрация

integer[]
Фильтр по ID доступов.
integer[]
Фильтр по ID пользователей.
boolean
Только активные (true) или неактивные (false) доступы.
Поиск по пользователю/продукту. Максимум 50 символов, пробелы по краям обрезаются.
integer[]
Фильтр по ID запусков (потоков).
integer[]
Фильтр по ID курсов: доступы к продуктам, которым принадлежат указанные курсы.
integer[]
Фильтр по ID текущего урока участника.
integer[]
Фильтр по ID пользователей, выдавших доступ.
integer[]
Фильтр по ID кураторов (менеджеров продавца).
enum[]
Статус участника: InUse, Completed.
boolean
Включать доступы, выданные как часть родительского доступа (бандла).
object
Диапазон даты истечения доступа.
object
Диапазон даты выдачи доступа.
object
Диапазон процента прохождения. Поля from / to (число); хотя бы одно обязательно.

Фильтры биллинга (подписки/рассрочки)

boolean
Только с активным (true) биллингом. «Активный» — продление не отменено и первая оплата уже прошла (доступы в ожидании входного платежа, WaitingEntryFee, не считаются активными).
enum[]
Тип биллинга продукта: Installment (рассрочка), Subscription (подписка).
enum[]
Статус биллинга доступа: Scheduled, Processing, Paid, Failed, WaitingEntryFee, CanceledByUser, CanceledByFailedAutoCharge, CanceledByReinitialization, CanceledByFailedManualCharge, CanceledByPreviousCancellation.
enum[]
Интервал списания: Week, Month, Year.
integer[]
Фильтр по ID счетов биллинга.
object
Диапазон суммы биллинга. Поля from / to (число); хотя бы одно обязательно.
object
Диапазон даты текущего платежа биллинга. Поля from / to (ISO 8601).
object
Диапазон даты следующего платежа биллинга. Поля from / to (ISO 8601).

Вложенные фильтры

object
Фильтр по продукту.
object
Фильтр по тарифу (цене) продукта.
object
Фильтр по пользователю.

Поля ответа

object
Постраничный список доступов (компактная проекция). Полная структура — productAccess в справочнике product.

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

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

Обновлено: 2026-07-22 12:19 UTC