v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Users

Get Lms User By Id

Returns an LMS User object with the given id.

get/api/lms/v1/users/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

first_namestring nullable

The first name of the user

last_namestring nullable

The last name of the user

middle_namestring nullable

The middle name of the user

email_addressstring nullable

The email address of the user

phone_numberstring nullable

The phone number of the user

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

The status of the user. If the value is not one of the defined enum values, the original value passed through will be returned.

Example response

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