Skip to main content
GET
/
api
/
ats
/
v1
/
remote-users
/
{id}
Get Remote User By Id
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/remote-users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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",
  "disabled": false,
  "remote_created_at": "2021-01-01T00:00:00Z",
  "access_role": "ADMIN",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

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

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false

Include raw data in the response

Example:

false

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

Response

Successful Response

The AtsRemoteUser object represents a user profile from a remote system that interacts with the ATS.

​
id
string<uuid>
required
Example:

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

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

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

Example:

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

​
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"
}
​
first_name
string | null
required

The first name of the user.

Example:

"John"

​
last_name
string | null
required

The last name of the user.

Example:

"Doe"

​
email
string | null
required

The email address of the user.

Example:

"john@doe.com"

​
disabled
boolean | null
required

Indicates whether the user's account is disabled.

Example:

false

​
remote_created_at
string | null
required

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

Example:

"2021-01-01T00:00:00Z"

​
access_role
enum<string>
required

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.

Available options:
ADMIN,
SUPER_ADMIN,
TEAM_MEMBER,
LIMITED_TEAM_MEMBER,
INTERVIEWER,
RECRUITER,
-
Example:

"ADMIN"

​
raw_data
Raw Data · object

This is the Raw data

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