Skip to main content

Request headers

string
required
The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.
integer
required
The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.
integer
required
The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.
Requires authentication and the “Forms management” permission (FormManage).

Request parameters

All filter parameters are optional. If you pass no filters, all available custom field values within the school are returned.
Array parameters are passed by repeating the parameter in the query string: userIds=1&userIds=2&userIds=3.

Pagination

integer
Number of records to skip. Defaults to 0.
integer
Number of records per page. From 1 to 1000. Defaults to 100.
integer
Page number (starting at 1). An alternative to skip — the offset is calculated automatically as (page - 1) * take.

Sorting

enum
Sort by record ID. Possible values: ASC, DESC.
enum
Sort by creation date. Possible values: ASC, DESC.
enum
Sort by update date. Possible values: ASC, DESC.
enum
Sort by the field’s order number. Possible values: ASC, DESC.

Filtering

integer[]
An array of user IDs. Returns field values only for the specified users.
integer[]
An array of field IDs. Returns values only for the specified fields.
string[]
An array of field slugs. An alternative to fieldIds for filtering by symbolic codes.
integer[]
An array of form fill IDs. Returns values bound to specific fills.
string[]
An array of form layout UUIDs.
string[]
An array of form layout slugs.
enum[]
An array of layout modes. Possible values: Custom, Form, Signup, Welcome, Participant.
integer[]
An array of product IDs. Returns values related to the specified products.
Values of fields with api = false in the RBAC settings are automatically excluded from the response. Field visibility is configured in the school’s admin panel. The exclusion happens after the page is fetched: count includes hidden values too, so a page may contain fewer items than take. To iterate over pages, rely on isLast / pages, not on the size of items.
You can get fieldId, the field slug and layoutId from the nested field object in this method’s response, and the list of forms with their id from the form list. The form fields themselves are created and configured in the school’s admin panel — they cannot be created via the API.

Response fields

Each item contains:
  • value — the field value (a string, number, boolean, date or JSON object, depending on the field type)
  • field — a nested object with field information (id, slug, type, order, layoutId, props, preference, permissions)
  • userId, fieldId — identifiers for linking
  • typed columns (text, number, boolean, date, json) are also present in the response depending on the field type; the convenience field value holds the already-cast value

Permission requirements

Getting custom field values requires the service user to have the “Forms management” permission (FormManage).
The service user must be authenticated with a token and have the appropriate access permissions for the specified school.
Data is returned only within the specified school. Field values of users from other schools are not included in the response.

Updated: 2026-09-25 14:33 UTC