API reference / Enrolments
List your organization's enrolments
GET
/v1/enrolmentsNeeds a bearer access token with the enrolments.read scope. How authentication works
Who from your organization is enrolled in what, their progress status, and when they finish (or finished). Filter by status or a specific user_id to narrow it down — e.g. status=completed for a compliance report of everyone who's finished mandatory training.
Query parameters
statusstringqueryOnly return enrolments with this status.
Allowed values:
in_progresscompleteduser_idstring · uuidqueryOnly return enrolments for this learner.
limitintegerqueryPage size. Default 25, maximum 100.
offsetintegerqueryHow many results to skip before the first one returned. Maximum 10,000.
Responses
- 200A page of enrolments
Response fields
dataarray of Enrolmentidstring · uuiduser_idstring · uuidcourse_idstring · uuidstatusstringAllowed values:
in_progresscompletedenrolled_atstring · date-timecompleted_atstring · date-timenullableaccess_expires_atstring · date-timenullable
totalinteger
