Get course enrollments

Retrieve the course enrollments of users in your organization, with due dates and completion expiry dates.

Returns the course enrollments of users in your organization, with the start date, due date and completion expiry date of each enrollment. Filter by user ID, course ID, or course external ID. When you set both course_id and course_external_id, an enrollment must match both.

Requirements

Enrollments

The endpoint returns an enrollment only for a user who has access to the course now. When a user loses access to a course, their enrollment is no longer returned.

When a user completed a course, the due date is the due date at the time of completion. A later change to the due date of the enrollment does not change it. To find out if a user completed a course on time, compare completed_at from the course progress data feed with due_at.

Paging

Send page_size (1 to 1000, default 25). To get the next page, send the next_page_token value from the previous response as page_token, and keep all other parameters the same. When next_page_token is empty, there are no more results.

Results are ordered by course ID, then by an internal user key that the response does not include. The order is stable, so paging with page_token does not repeat or skip an enrollment that exists for the whole walk.

πŸ“˜

The course progress data feed does not contain due dates or completion expiry dates, or users who have not started a course. Use this endpoint to get them.

Query Params
int32

[Optional] The number of items to return. Defaults to 25. You can specify a value between 1 to 1000.

string

[Optional] If present, retrieves the next batch of results from the preceding call to this method. Must be the value of next_page_token from the previous response, with all other parameters identical to that call.

string

[Optional] User ID to filter by. Accepts either a UUID or the user_ prefixed form.

string

[Optional] Course ID to filter by. When set with course_external_id, an enrollment must match both.

string

[Optional] Course external ID to filter by. Matches every course with this external ID. When set with course_id, an enrollment must match both.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json