Request headers
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.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.
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.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
Page number (starting at
1). An alternative to skip — the offset is calculated automatically as (page - 1) * take.Sorting
Filtering
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 fieldvalueholds the already-cast value
Permission requirements
Getting custom field values requires the service user to have the “Forms management” permission (
FormManage).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