Skip to main content
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": "sarah.johnson@acme.com",
        "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.

​
email
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
Examples:
{
  "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
  "results": [
    {
      "id": "26vafvWSRmbhNcxJYqjCzuJg",
      "remote_id": "32",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "work_email": "sarah.johnson@acme.com",
      "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
    }
  ]
}