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.SchoolManageUsers).
All filter parameters are optional. Without filters, the method returns all school users, subject to
pagination. Each response item is a
userWithProfile object (a user with a nested profile).Pass array parameters by repeating the parameter:
statuses=Active&statuses=OnLeave. Pass date ranges as
nested fields: createdAtDateRange[from]=2026-01-01&createdAtDateRange[to]=2026-02-01.Request parameters
Pagination
integer
Number of records per page. From
1 to 1000. Defaults to 100.integer
Page number (starting from
1). An alternative to skip.integer
Number of records to skip. Defaults to
0.Filtering
string
Search by first name, last name, email, phone and domain login. Maximum 50 characters.
enum[]
Filter by account status:
Active, OnLeave, Banned, Blocked, Terminated, Deleted.
Statuses are described in the user reference.boolean
Filter by the confirmed sign-in flag (
true/false).boolean
Filter by archive state:
true — archived only, false — non-archived only.integer[]
Filter by user IDs.
string[]
Filter by external IDs from your system. 1 to 50 characters each, maximum 250 items.
object
Creation date range:
createdAtDateRange[from], createdAtDateRange[to] (ISO 8601).object
Last activity range:
lastOnlineAtDateRange[from], lastOnlineAtDateRange[to] (ISO 8601).object
Filter by sign-up UTM tags. The
value field is an array of { key, value } pairs (non-empty strings).object
Archiving (deletion) date range:
archivedAtDateRange[from], archivedAtDateRange[to] (ISO 8601).integer[]
Filter by IDs of the users who performed the archiving (deletion).
object
Nested profile filter.
Sorting
enum
Sort by ID:
ASC or DESC.enum
Sort by creation date:
ASC or DESC.enum
Sort by last activity:
ASC or DESC.enum
Sort by update date:
ASC or DESC.enum
Sort by “stars” balance:
ASC or DESC.enum
Sort by number of product accesses:
ASC or DESC.enum
Sort by archiving date:
ASC or DESC.enum
Sort by internal order:
ASC or DESC.Response fields
Permission requirements
Requires token authentication and the “School User Management” permission (
SchoolManageUsers).Updated: 2026-09-25 14:33 UTC