Skip to main content
GET
Search CourseCompletedLessons
A CourseCompletedLesson records that a specific CourseMember has completed a specific CourseLesson. Each record is the junction between a lesson and the enrolled member who finished it. These records are typically created automatically by the Members Portal when a member meets the lesson’s completion criteria (e.g. visiting the lesson page, clicking a completion button, or finishing a video). They can also be created or deleted manually via the API to manage progress programmatically. Use this entity to query which lessons a member has completed, or to find all members who have completed a given lesson.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CourseCompletedLesson-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the course lesson that was completed.
string
Filter by title of the completed lesson.
integer
Filter by iD of the course enrolment (CourseMember) record for the member who completed the lesson.
string
Filter by full name of the member who completed the lesson.
string
Filter by company name of the member who completed the lesson.
string
Filter by comma-separated list of teams the member belongs to.

Range Filters

string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

CourseCompletedLesson[]
The list of CourseCompletedLesson records matching the query. See the Get one CourseCompletedLesson endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response