GET
/
api
/
lms
/
v1
/
users
Get Users
curl --request GET \
  --url https://api.bindbee.dev/api/lms/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Query Parameters

​
remote_id
string

The third-party API ID of the matching object.

​
email_address
string

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

​
status
enum<string>

If provided, will only return enrollments for this status.

Available options:
ACTIVE,
PENDING,
INACTIVE
​
include_raw_data
boolean
default:false

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

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

​
page_size
integer
default:50

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

Required range: 1 <= x <= 100
​
cursor
string

The pagination cursor value.

Response

200
application/json

Successful Response

The response is of type object.