Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Users

Get Lms Users

Returns a list of LMS User objects.

get/api/lms/v1/users

Query parameters

idsstring nullable

If provided, will only return users for these IDs.

Example:018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7

If provided, will only return users for these IDs.

remote_idstring

The third-party API ID of the matching object.

The third-party API ID of the matching object.

email_addressstring

If provided, will only return users for this email address.

Example:john@doe.com

If provided, will only return users for this email address.

status'ACTIVE' | 'PENDING' | 'INACTIVE'

If provided, will only return enrollments for this status.

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

Number of results to return per page. Maximum size is 200.

cursorstring

The pagination cursor value.

The pagination cursor value.

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "first_name": "Jane",
      "last_name": "Doe",
      "middle_name": "A.",
      "email_address": "jane.doe@example.com",
      "phone_number": "+1 415 555 1212",
      "status": "ACTIVE"
    }
  ]
}