Skip to main content
GET
/
api
/
ats
/
v1
/
candidates
Get Candidates
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 123,
  "items": [
    {
      "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"
      },
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "first_name": "John",
      "last_name": "Doe",
      "company": "Google",
      "title": "SOFTWARE ENGINEER",
      "last_interaction_at": "2021-07-01T00:00:00Z",
      "is_private": true,
      "can_email": true,
      "locations": "San Francisco",
      "phone_numbers": "123-456-7890",
      "email_addresses": "john@doe.com",
      "urls": {
        "type": "LINKEDIN",
        "value": "https://www.linkedin.com/in/johndoe"
      },
      "tags": "JUNIOR",
      "applications": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "attachments": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "remote_created_at": "2021-07-01T00:00:00Z",
      "remote_updated_at": "2021-07-01T00:00:00Z",
      "avatar": "https://www.example.com/avatar.jpg"
    }
  ]
}

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 candidates to fetch

Example:

"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"

​
remote_id
string

The third-party API ID of the matching object.

Example:

"3235005483341316245"

​
company
string | null

If provided, will only return candidate for these companies

Example:

"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"

​
first_name
string

If provided, will return candidates with this first name

Example:

"Radhe"

​
last_name
string

If provided, will return candidates with this last name

Example:

"Mohan"

​
tag
string

If provided, will return candidates with this tag

Example:

"Tech Experience"

​
email_addresses
string[]

If provided, will return candidates with these email addresses

Examples:

"john@doe.com"

"jane@doe.com"

​
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

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

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

Example:

"manager[first_name,last_name]"

​
modified_after
string

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

Example:

"2024-02-21T21:22:12.993Z"

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