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.
All filter parameters are optional. If you pass no filters, all members of all school groups are returned, subject to pagination.
Pass array parameters by repeating the parameter in the query string: groupIds=1&groupIds=2&groupIds=3.

Request parameters

Pagination

integer
Number of records to skip. Default: 0.
integer
Page number (an alternative to skip). Starts at 1.
integer
Number of records per page. From 1 to 1000. Default: 100.

Filtering

integer[]
Filter by group IDs.
integer[]
Filter by member user IDs.
integer[]
Filter by member record IDs.
integer[]
Filter by IDs of inviting users.
integer[]
Filter by IDs of the products the groups are linked to.
boolean
Filter by whether the member is active in the group.
Search by the member’s login (email, phone) and name. Maximum 50 characters.
object
Date range of being added to the group.

Response fields

object
Paginated list of group members. For the base member structure, see the groupMember reference; for the user, see the user reference.

Permission requirements

Requires token authentication and the “School User Management” permission (SchoolManageUsers).

Updated: 2026-09-25 14:33 UTC