Sign in

v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified LMS API

Check course progression

Check in real time whether a user is enrolled in a course and read their progression.

Answers the question "is this user enrolled in this course?" by querying the remote system directly, bypassing the data from the most recent sync. Use this when you need an authoritative enrollment check without waiting for the next sync.

Example Request Body

{
  "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
  "course_id": "26vafvWSRmbhNcxJYqjCzuJg"
}
post/lms/check-course-progression

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

user_idstring required

The ID of the user in Kombo or their ID in the remote system by prefixing it with remote: (e.g., remote:12312).

course_idstring required

The ID of the course in Kombo or its ID in the remote system by prefixing it with remote: (e.g., remote:12312).

Response

POST /lms/check-course-progression Positive response

status'success' required

Example response

{
  "data": {
    "is_enrolled": true,
    "course_progression": {
      "id": "26vafvWSRmbhNcxJYqjCzuJg",
      "remote_id": "progress-12345",
      "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
      "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz",
      "status": "ENROLLED",
      "enrolled_at": "2024-04-15T00:00:00.000Z",
      "completed_at": null,
      "changed_at": "2024-04-15T00:00:00.000Z",
      "remote_deleted_at": null,
      "remote_data": null,
      "user": {
        "id": "7xPdr68N8kG9EzLwjsN9xyz",
        "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"
        }
      }
    }
  }
}