Заголовки запроса
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат:
Bearer YOUR_TOKEN.string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
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 продуктов. Возвращает значения, связанные с указанными продуктами.
Поля ответа
Каждый элемент содержит:
value— значение поля (строка, число, boolean, дата или JSON-объект в зависимости от типа поля)field— вложенный объект с информацией о поле (id,slug,type,order,layoutId,props,preference,permissions)userId,fieldId— идентификаторы для связи- типизированные столбцы (
text,number,boolean,date,json) также присутствуют в ответе в зависимости от типа поля; удобное полеvalueсодержит уже приведённое значение
Требования к правам доступа
Для получения значений кастомных полей требуется право FormManage у сервисного пользователя.
Данные возвращаются только в рамках указанной школы. Значения полей пользователей из других школ не будут включены в ответ.
Обновлено: 2026-07-08 06:09 UTC