GET
/
api
/
ats
/
v1
/
remote-users
Get Remote Users
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/remote-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": "John",
      "last_name": "Doe",
      "email": "john@doe.com",
      "disabled": false,
      "remote_created_at": "2021-01-01T00:00:00Z",
      "access_role": "ADMIN"
    }
  ]
}

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

The ID of the remote users to fetch

​
email
string

Email id of the user

​
include_raw_data
boolean
default:false

Include raw data in the response

​
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.

​
modified_after
string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

​
expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

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
AtsRemoteUser · object[]
required