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.
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.
To check whether a user has access to a course: userIds=<user ID>&courseIds=<course ID>&active=true. You can get a course’s productId and courseId from the course list.

Request parameters

Pagination

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

Filtering

integer[]
Filter by access IDs.
integer[]
Filter by user IDs.
boolean
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.
integer[]
Filter by group IDs: accesses of users who are currently members of at least one of the specified groups.
enum[]
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.
Search by user/product. Up to 50 characters; leading and trailing spaces are trimmed.
integer[]
Filter by launch (cohort) IDs.
integer[]
Filter by course IDs: accesses to the products that the specified courses belong to.
integer[]
Filter by the participant’s current lesson ID.
integer[]
Filter by IDs of the users who granted the access.
integer[]
Filter by curator IDs (seller managers).
enum[]
Participant status: InUse, Completed.
boolean
Include accesses granted as part of a parent access (bundle).
object
Access expiration date range.
object
Access grant date range.
object
Completion percentage range. Fields from / to (number); at least one is required.

Billing filters (subscriptions/installments)

boolean
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).
enum[]
Product billing type: Installment (installment plan), Subscription (subscription).
enum[]
Access billing status: Scheduled, Processing, Paid, Failed, WaitingEntryFee, CanceledByUser, CanceledByFailedAutoCharge, CanceledByReinitialization, CanceledByFailedManualCharge, CanceledByPreviousCancellation.
enum[]
Charge interval: Week, Month, Year.
integer[]
Filter by billing invoice IDs.
object
Billing amount range. Fields from / to (number); at least one is required.
object
Date range of the current billing payment. Fields from / to (ISO 8601).
object
Date range of the next billing payment. Fields from / to (ISO 8601).

Nested filters

object
Filter by product.
object
Filter by the product’s plan (price).
object
Filter by user.

Response fields

object
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