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.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
Filtering
Look for
search in one field only: Id (exact match, id123 also works), Phone (the digits of the number,
anywhere in it), Email (any part of the address), Name (first and last name in either order), Login (domain
login), TgId (exact match). Not passed — the search covers every field at once.Filter by account status:
Active, OnLeave, Banned, Blocked, Terminated, Deleted.
Statuses are described in the user reference.Filter by sign-up UTM tags. The
value field is an array of { key, value } pairs (non-empty strings).Archiving (deletion) date range:
archivedAtDateRange[from], archivedAtDateRange[to] (ISO 8601).Only employees with an active employment in the given departments or in
any of their child departments. For
Corporate schools.Only employees with an active employment in the given positions. For
Corporate schools.Range of the number of active product accesses:
productAccessesCountRange[from],
productAccessesCountRange[to] (numbers, bounds inclusive; one bound is enough).Same as
productAccessesCountRange, but only paid accesses are counted:
productAccessesPurchasedCountRange[from], productAccessesPurchasedCountRange[to].Sorting
Response fields
Paginated list of users. The item structure is described in the
user reference.Permission requirements
Requires token authentication and the “School User Management” permission (
SchoolManageUsers).Updated: 2026-10-16 13:24 UTC