v3

OpenAPI 3.1.02026-07-311255771.3 MB

Unified LMS API

Get course progressions

Retrieve all course progressions from the LMS system. Course progressions track users enrollment and completion status in courses.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)

get/lms/course-progressions

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

updated_afterstring date-time

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. Returns records where either the record itself OR its nested data has been updated since this timestamp, even if the record's own changed_at field remains unchanged.

If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

For more details, see Understanding changed_at vs updated_after Behavior.

For this endpoint, updated_after matches when the returned record changed, or when related data changed as described below.

Path	Added/Removed	Linked Record
user	✗ No	✗ No
course_revision	✗ No	✗ No

Added/Removed: Whether adding or removing entries from this list triggers an update (n/a for single records). Linked Record: Whether changes to the linked record itself trigger an update.

If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

For more details, see Understanding changed_at vs updated_after Behavior.

For this endpoint, updated_after matches when the returned record changed, or when related data changed as described below.

Path	Added/Removed	Linked Record
user	✗ No	✗ No
course_revision	✗ No	✗ No

Added/Removed: Whether adding or removing entries from this list triggers an update (n/a for single records). Linked Record: Whether changes to the linked record itself trigger an update.

include_deleted'true' | 'false'

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

ignore_unsupported_filters'true' | 'false'

When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.

idsstring

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

remote_idsstring

Filter by a comma-separated list of remote IDs.

user_idsstring

Filter by a comma-separated list of user IDs. We will only return progressions that are related to any of the users.

course_idsstring

Filter by a comma-separated list of course IDs. We will only return progressions for revisions that belong to any of the courses.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /lms/course-progressions Positive response

status'success' required

Example response

{
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "progress-12345",
        "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
        "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz",
        "status": "COMPLETED",
        "enrolled_at": "2022-08-07T14:01:29.196Z",
        "completed_at": "2022-08-07T14:01:29.196Z",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "remote_data": null,
        "user": {
          "id": "26vafvWSRmbhNcxJYqjCzuJg",
          "remote_id": "32",
          "first_name": "Sarah",
          "last_name": "Johnson",
          "work_email": "sarah.johnson@example.com"
        },
        "course_revision": {
          "id": "3KMdr68N8kG9EzLwjsN9aoz",
          "remote_id": "revision-12345",
          "title": "Building LMS integrations with Kombo",
          "course": {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "32"
          }
        }
      }
    ]
  }
}