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.Returns users’ accesses to the school’s products. All filter parameters are optional.
Array parameters are passed by repeating the parameter:
userIds=1&userIds=2.Request parameters
Pagination
Filtering
Only active (
true) or inactive (false) accesses. An access becomes inactive, for example, when
the user is removed from all groups of the product (member/delete-many).
Check expiration (expireAt) separately, with the expiryStatuses or expireAtDateRange filter.Filter by group IDs: accesses of users who are currently members of at least one of the specified groups.
Access expiry status (values are combined with “OR”):
NoExpiry: access with no expiration (expireAt=null);Active: expires in more than 14 days;Expiring: expires within the next 14 days;Expired: already expired.
Billing filters (subscriptions/installments)
Only with active (
true) billing. “Active” means renewal is not canceled and the first payment has already gone through
(accesses awaiting the entry payment, WaitingEntryFee, are not considered active).Access billing status:
Scheduled, Processing, Paid, Failed, WaitingEntryFee,
CanceledByUser, CanceledByFailedAutoCharge, CanceledByReinitialization,
CanceledByFailedManualCharge, CanceledByPreviousCancellation.Nested filters
Response fields
Paginated list of accesses (compact projection). For the full structure, see
productAccess in the
product reference.Permission requirements
Requires token authentication and one of the permissions: “School User Management” (
SchoolManageUsers)
or “Course Student Management” (CourseStudentManage).Updated: 2026-09-25 14:33 UTC