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.FormManage).
All filter parameters are optional. Without filters, the method returns all of the school’s form layouts, paginated.
The layout structure is the same as in the
form/layout/create response.Array parameters are passed by repeating the parameter:
modes=Form&modes=Signup.Request parameters
Pagination
integer
Number of records per page. From
1 to 1000. Defaults to 100.integer
Page number (starting at
1). An alternative to skip.integer
Number of records to skip. Defaults to
0.Filtering
integer[]
Filter by layout IDs.
string[]
Filter by layout UUIDs.
string[]
Filter by layout slugs.
enum[]
Filter by layout mode:
Form (form submission), Signup (user fields at registration),
Custom, Welcome, Participant (product participant questionnaire).enum[]
Filter by layout status:
Draft, Published.integer[]
Filter by product IDs (for layouts linked to a product, such as participant questionnaires).
string
Search by layout name. Maximum 50 characters.
Sorting
enum
Sort by ID:
ASC or DESC.enum
Sort by creation date:
ASC or DESC.Response fields
object
Paginated list of form layouts.
Permission requirements
Requires token authentication and the “Forms management” permission (
FormManage).Updated: 2026-09-25 14:33 UTC