Skip to main content

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

string
обязательно
API-токен сервисного пользователя в формате Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете: Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».
integer
обязательно
Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
integer
обязательно
Числовой ID школы, берётся там же, где Seller-Id. Значение должно совпадать со школой продавца — иначе вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".
Требуется аутентификация и право «Управление формами» (FormManage).

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

Все параметры фильтрации являются необязательными. Если не передать ни одного фильтра — будут возвращены все доступные значения кастомных полей в рамках школы.
Параметры-массивы передаются через повторение параметра в строке запроса: userIds=1&userIds=2&userIds=3.

Пагинация

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

Сортировка

enum
Сортировка по ID записи. Возможные значения: ASC, DESC.
enum
Сортировка по дате создания. Возможные значения: ASC, DESC.
enum
Сортировка по дате обновления. Возможные значения: ASC, DESC.
enum
Сортировка по порядковому номеру поля. Возможные значения: ASC, DESC.

Фильтрация

integer[]
Массив ID пользователей. Возвращает значения полей только для указанных пользователей.
integer[]
Массив ID полей. Возвращает значения только указанных полей.
string[]
Массив slug-идентификаторов полей. Альтернатива fieldIds для фильтрации по символьным кодам.
integer[]
Массив ID заполнений формы. Возвращает значения, привязанные к конкретным заполнениям.
string[]
Массив UUID макетов формы.
string[]
Массив slug-идентификаторов макетов формы.
enum[]
Массив режимов макета. Возможные значения: Custom, Form, Signup, Welcome, Participant.
integer[]
Массив ID продуктов. Возвращает значения, связанные с указанными продуктами.
Значения полей, для которых в настройках RBAC установлено api = false, автоматически исключаются из ответа. Настройки видимости полей задаются в панели управления школы. Исключение происходит уже после выборки страницы: count учитывает и скрытые значения, поэтому на странице может оказаться меньше элементов, чем take. Для перебора страниц ориентируйтесь на isLast / pages, а не на размер items.
fieldId, slug поля и layoutId можно взять из вложенного объекта field в ответе этого метода, а список форм и их id — из списка форм. Сами поля формы создаются и настраиваются в кабинете школы — через API их создать нельзя.

Поля ответа

Каждый элемент содержит:
  • 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