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.
Course visibility restrictions do not apply to the API. A course has access modes for the school team (“All” / “Assigned”) that hide a restricted course from managers in the interface. The API returns data for all school courses regardless of these modes: access is determined only by the service user’s token and its permissions.
Returns lesson progress records of the selected course for all participants. Each record corresponds to a “user + lesson” pair. Records are created as the course is taken, so there may be no record for lessons the participant has not reached yet. The method has no filters by user or lesson: filter by userId / lessonId on your side.
To receive progress changes without periodically polling this method, subscribe to the CourseProgressChanged and CourseCompleted webhooks — see Webhooks.

Path parameters

integer
required
ID of the course to get progress for — the courseId field 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.

Response fields

object
A paginated list of progress records. The full record structure is courseProgress in the course reference.

Permission requirements

Requires token authentication and one of the permissions: “Course Curator” (CourseCurator) or “School User Management” (SchoolManageUsers).

Updated: 2026-09-25 14:33 UTC