Create progress

curl --request POST \
  --url https://api.kombo.dev/v1/lms/progress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "course_id": "<string>",
  "user_id": "<string>",
  "progress_id": "<string>",
  "status": "ENROLLED",
  "enrollment_date": "<string>",
  "completion_date": "<string>",
  "score": -1.7976931348623157e+308,
  "duration": -1.7976931348623157e+308,
  "comments": "<string>"
}
'

{
  "status": "success",
  "data": {
    "id": "7xPdr68N8kG9EzLwjsN9xyz",
    "remote_id": "892476",
    "course_id": "3KMdr68N8kG9EzLwjsN9aoz",
    "user_id": "26vafvWSRmbhNcxJYqjCzuJg",
    "status": "COMPLETED",
    "enrollment_date": "2024-03-01T10:00:00.000Z",
    "completion_date": "2024-04-15T16:30:00.000Z",
    "score": 92.5,
    "duration": 480,
    "comments": "Excellent performance throughout the course.",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_data": null
  }
}

POST

lms

progress

Create progress

curl --request POST \
  --url https://api.kombo.dev/v1/lms/progress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "course_id": "<string>",
  "user_id": "<string>",
  "progress_id": "<string>",
  "status": "ENROLLED",
  "enrollment_date": "<string>",
  "completion_date": "<string>",
  "score": -1.7976931348623157e+308,
  "duration": -1.7976931348623157e+308,
  "comments": "<string>"
}
'

{
  "status": "success",
  "data": {
    "id": "7xPdr68N8kG9EzLwjsN9xyz",
    "remote_id": "892476",
    "course_id": "3KMdr68N8kG9EzLwjsN9aoz",
    "user_id": "26vafvWSRmbhNcxJYqjCzuJg",
    "status": "COMPLETED",
    "enrollment_date": "2024-03-01T10:00:00.000Z",
    "completion_date": "2024-04-15T16:30:00.000Z",
    "score": 92.5,
    "duration": 480,
    "comments": "Excellent performance throughout the course.",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_data": null
  }
}

Closed Beta Feature: This endpoint is currently in closed beta. We’re testing it with selected customers before its public release. If you’re interested in learning more or getting early access, please reach out.

Create a new progress entry for a user in a course. This records enrollment, completion, scores, and other learning metrics.

Authorizations

Authorization

string

header

required

Create an API key on the Secrets page in the Kombo dashboard.

Body

application/json

POST /lms/progress Request body

course_id

string

required

The ID of the course.

user_id

string

required

The ID of the user.

progress_id

string

required

Unique identifier for this progress entry.

status

enum<string>

required

Current status of the learner in this course.

Available options:

ENROLLED,

STARTED,

COMPLETED,

STOPPED

enrollment_date

string

required

Date when the user enrolled in the course.

completion_date

string | null

Date when the user completed the course.

score

number<double> | null

Numerical score achieved (e.g., 85.5).

Required range: x >= -1.7976931348623157e+308

duration

number<double> | null

Total time spent on the course in minutes.

Required range: x >= -1.7976931348623157e+308

comments

string | null

Additional comments or notes.

Response

POST /lms/progress Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

data.id

string

required

The Kombo ID of the progress entry.

data.remote_id

string

required

The remote ID of the progress entry.

data.course_id

string

required

The ID of the course this progress relates to.

data.user_id

string

required

The ID of the user this progress belongs to.

data.status

enum<string>

required

Current status of the learner in this course.

Available options:

ENROLLED,

STARTED,

COMPLETED,

STOPPED

data.enrollment_date

string | null

required

Date when the user enrolled in the course.

data.completion_date

string | null

required

Date when the user completed the course.

data.score

number<double> | null

required

Numerical score achieved by the user (e.g., 85.5).

Required range: x >= -1.7976931348623157e+308

data.duration

number<double> | null

required

Total time spent on the course in minutes.

Required range: x >= -1.7976931348623157e+308

data.comments

string | null

required

Additional comments or notes about the progress.

data.changed_at

string<date-time>

required

The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the updated_after parameter which will return records when either the record itself OR its related models have been updated.

data.remote_data

object

required

Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set.

Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: { "/companies": { ... }}

This is not available on all plans. Reach out to Kombo if you need it.

Create course Update progress

⌘I

General

Features

Guides

LMS API Reference

General API Reference

Create progress

Authorizations

Body

Response