Skip to main content

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

​
Authorization
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
​
Seller-Id
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
​
School-Id
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

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

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

​
Пагинация

​
skip
integer
Количество записей, которые нужно пропустить. По умолчанию 0.
​
take
integer
Количество записей на странице. По умолчанию 20.

​
Сортировка

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

​
Фильтрация

​
userIds
integer[]
Массив ID пользователей. Возвращает значения полей только для указанных пользователей.
​
fieldIds
integer[]
Массив ID полей. Возвращает значения только указанных полей.
​
fieldSlugs
string[]
Массив slug-идентификаторов полей. Альтернатива fieldIds для фильтрации по символьным кодам.
​
fillIds
integer[]
Массив ID заполнений формы. Возвращает значения, привязанные к конкретным заполнениям.
​
layoutUuids
string[]
Массив UUID макетов формы.
​
layoutSlugs
string[]
Массив slug-идентификаторов макетов формы.
​
layoutModes
enum[]
Массив режимов макета. Возможные значения: Custom, Form, Signup, Welcome, Participant.
​
productIds
integer[]
Массив ID продуктов. Возвращает значения, связанные с указанными продуктами.
Значения полей, для которых в настройках RBAC установлено api = false, автоматически исключаются из ответа. Настройки видимости полей задаются в панели управления школы.
curl --location --request GET 'https://api.exode.biz/saas/v2/form/custom-field/value/get?userIds=27&userIds=42&fieldSlugs=city&fieldSlugs=company&createdAt=DESC' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "code": 200,
  "payload": {
    "items": [
      {
        "id": 1,
        "userId": 27,
        "fieldId": 10,
        "fillId": null,
        "value": "Ташкент",
        "field": {
          "id": 10,
          "slug": "city",
          "type": "Text",
          "name": "Город",
          "order": 0
        },
        "createdAt": "2025-03-10T12:00:00.000Z",
        "updatedAt": "2025-03-10T12:00:00.000Z"
      },
      {
        "id": 2,
        "userId": 27,
        "fieldId": 11,
        "fillId": null,
        "value": "ООО «Компания»",
        "field": {
          "id": 11,
          "slug": "company",
          "type": "Text",
          "name": "Компания",
          "order": 1
        },
        "createdAt": "2025-03-10T12:00:00.000Z",
        "updatedAt": "2025-03-10T12:00:00.000Z"
      },
      {
        "id": 3,
        "userId": 42,
        "fieldId": 10,
        "fillId": null,
        "value": "Ташкент",
        "field": {
          "id": 10,
          "slug": "city",
          "type": "Text",
          "name": "Город",
          "order": 0
        },
        "createdAt": "2025-03-10T14:30:00.000Z",
        "updatedAt": "2025-03-10T14:30:00.000Z"
      }
    ],
    "count": 3,
    "page": 1,
    "pages": 1,
    "isFirst": true,
    "isLast": true,
    "next": null,
    "prev": null
  }
}

​
Поля ответа

Каждый элемент содержит:
  • value — значение поля (строка, число, boolean, дата или JSON-объект в зависимости от типа поля)
  • field — вложенный объект с информацией о поле (id, slug, type, name, order)
  • userId, fieldId — идентификаторы для связи

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

Для получения значений кастомных полей требуется право FormManage у сервисного пользователя.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.
Данные возвращаются только в рамках указанной школы. Значения полей пользователей из других школ не будут включены в ответ.