Get users

curl --request GET \
  --url https://api.kombo.dev/v1/lms/users \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "first_name": "Sarah",
        "last_name": "Johnson",
        "work_email": "[email protected]",
        "status": "ACTIVE",
        "remote_created_at": "2022-08-07T14:01:29.196Z",
        "progress": [
          {
            "course_id": "3KMdr68N8kG9EzLwjsN9aoz",
            "progress_id": "7xPdr68N8kG9EzLwjsN9xyz",
            "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."
          },
          {
            "course_id": "9ZMdr68N8kG9EzLwjsN9def",
            "progress_id": "2wQdr68N8kG9EzLwjsN9abc",
            "status": "STARTED",
            "enrollment_date": "2024-05-10T08:00:00.000Z",
            "completion_date": null,
            "score": null,
            "duration": 120,
            "comments": null
          }
        ],
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_data": null
      }
    ]
  }
}

GET

lms

users

Get users

curl --request GET \
  --url https://api.kombo.dev/v1/lms/users \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "first_name": "Sarah",
        "last_name": "Johnson",
        "work_email": "[email protected]",
        "status": "ACTIVE",
        "remote_created_at": "2022-08-07T14:01:29.196Z",
        "progress": [
          {
            "course_id": "3KMdr68N8kG9EzLwjsN9aoz",
            "progress_id": "7xPdr68N8kG9EzLwjsN9xyz",
            "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."
          },
          {
            "course_id": "9ZMdr68N8kG9EzLwjsN9def",
            "progress_id": "2wQdr68N8kG9EzLwjsN9abc",
            "status": "STARTED",
            "enrollment_date": "2024-05-10T08:00:00.000Z",
            "completion_date": null,
            "score": null,
            "duration": 120,
            "comments": null
          }
        ],
        "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.

Retrieve all users from the LMS system. Users are learners who can enroll in and complete courses. The response includes their current progress across all enrolled courses.

Authorizations

Authorization

string

header

required

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

Query Parameters

ids

string

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

remote_ids

string

Filter by a comma-separated list of remote IDs.

string

Filter users by their work email address.

status

enum<string>

Filter users by their current status.

Available options:

ACTIVE,

INACTIVE

Response

GET /lms/users Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

data.next

string | null

required

Cursor string that can be passed to the cursor query parameter to get the next page. If this is null, then there are no more pages.

data.results

object[]

required

Show child attributes

data.results.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.results.remote_id

string

required

The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.

data.results.first_name

string | null

required

The user's first name.

data.results.last_name

string | null

required

The user's last name.

data.results.work_email

string | null

required

The user's work email address.

data.results.status

enum<string>

required

Current status of the user in the LMS.

Available options:

ACTIVE,

INACTIVE

data.results.remote_created_at

string<date-time> | null

required

The date and time the object was created in the remote system.

data.results.progress

object[]

required

Array of course progress records for this user.

Show child attributes

data.results.progress.course_id

string

required

The ID of the course this progress relates to.

data.results.progress.progress_id

string

required

Unique identifier for this progress entry.

data.results.progress.status

enum<string>

required

Current status of the learner in this course.

Available options:

ENROLLED,

STARTED,

COMPLETED,

STOPPED

data.results.progress.enrollment_date

string | null

required

Date when the user enrolled in the course.

data.results.progress.completion_date

string | null

required

Date when the user completed the course.

data.results.progress.score

number<double> | null

required

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

Required range: x >= -1.7976931348623157e+308

data.results.progress.duration

number<double> | null

required

Total time spent on the course in minutes.

Required range: x >= -1.7976931348623157e+308

data.results.progress.comments

string | null

required

Additional comments or notes about the progress.

data.results.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.results.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.

Partner Credentials Get courses

⌘I

General

Features

Guides

LMS API Reference

General API Reference

Get users

Authorizations

Query Parameters

Response