Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Courses::LessonCompletion

List Lesson Completions

List of enrollment-completion records showing which lessons have been completed by which enrollments. You can filter on one or more enrollment_id or lesson_id records (see filter params).

get/courses/{course_id}/lesson_completions

Path parameters

course_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

enrollment_idstring

A comma-separated list of enrollement IDs to filter by.

lesson_idstring

A comma-separated list of lesson IDs to filter by.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "enrollment_id": "1,42",
  "lesson_id": "1,2,3"
}

Response

OK

idinteger

ID

public_idstring nullable

Public ID

enrollment_idinteger

The ID of the Courses::Enrollment record that completed the lesson

lesson_idinteger

The ID of the Courses::Lesson record that was completed

completed_atstring date-time

The time when the record was completed; It is set automatically to the current time when the record is created

Example response

[
  {
    "id": 1,
    "public_id": "MkFHBo",
    "enrollment_id": 2,
    "lesson_id": 2,
    "completed_at": "2025-01-01T00:00:00.000Z"
  }
]