Get Lms Users - Bindbee Docs

GET

api

lms

users

Get Lms 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",
      "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"
      },
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "first_name": "Jane",
      "last_name": "Doe",
      "middle_name": "A.",
      "email_address": "[email protected]",
      "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

ids

string | null

If provided, will only return users for these IDs.

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

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

LmsUser · object[]

required

Show child attributes

items.id

string<uuid>

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

items.custom_fields

Custom Fields · object

required

The custom fields related to the model

Example:

{
  "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"
}

items.raw_data

Raw Data · object

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

items.first_name

string | null

The first name of the user

Example:

"Jane"

items.last_name

string | null

The last name of the user

Example:

"Doe"

items.middle_name

string | null

The middle name of the user

Example:

"A."

items.email_address

string | null

The email address of the user

Example:

"[email protected]"

items.phone_number

string | null

The phone number of the user

Example:

"+1 415 555 1212"

items.status

string | null

The status of the user. Possible values include: ACTIVE, PENDING, INACTIVE or - in cases where there is no clear mapping - the original value passed through

Example:

"ACTIVE"

Get Lms User By IdReturns an LMS User object with the given id.

⌘I

Get Lms 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",
      "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"
      },
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "first_name": "Jane",
      "last_name": "Doe",
      "middle_name": "A.",
      "email_address": "[email protected]",
      "phone_number": "+1 415 555 1212",
      "status": "ACTIVE"
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response