v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Remote User

Get Remote User By Id

Returns a RemoteUser object with the given id.

get/api/ats/v1/remote-users/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Include raw data in the response

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 required

The first name of the user.

last_namestring nullable required

The last name of the user.

emailstring nullable required

The email address of the user.

disabledboolean nullable required

Indicates whether the user's account is disabled.

remote_created_atstring nullable required

The ISO date string when the user profile was created in the remote system.

The role of the user defining their level of access. 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": "John",
  "last_name": "Doe",
  "email": "john@doe.com",
  "remote_created_at": "2021-01-01T00:00:00Z",
  "access_role": "ADMIN"
}