Заголовки запроса
API-токен сервисного пользователя в формате
Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете:
Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в
карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
Числовой ID школы, берётся там же, где
Seller-Id. Значение должно совпадать со школой продавца — иначе
вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".FormManage).
Параметры запроса
Все параметры фильтрации являются необязательными. Если не передать ни одного фильтра — будут возвращены все доступные значения кастомных полей в рамках школы.
Параметры-массивы передаются через повторение параметра в строке запроса:
userIds=1&userIds=2&userIds=3.Пагинация
Номер страницы (от
1). Альтернатива skip — смещение вычисляется автоматически как (page - 1) * take.Сортировка
Фильтрация
Массив slug-идентификаторов полей. Альтернатива
fieldIds для фильтрации по символьным кодам.Поля ответа
Каждый элемент содержит:
value— значение поля (строка, число, boolean, дата или JSON-объект в зависимости от типа поля)field— вложенный объект с информацией о поле (id,slug,type,order,layoutId,props,preference,permissions)userId,fieldId— идентификаторы для связи- типизированные столбцы (
text,number,boolean,date,json) также присутствуют в ответе в зависимости от типа поля; удобное полеvalueсодержит уже приведённое значение
Требования к правам доступа
Для получения значений кастомных полей требуется право «Управление формами» (
FormManage) у сервисного пользователя.Данные возвращаются только в рамках указанной школы. Значения полей пользователей из других школ не будут включены в ответ.
Обновлено: 2026-09-25 13:43 UTC