GET
/
api
/
ats
/
v1
/
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": 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",
      "company": "Google",
      "title": "SOFTWARE ENGINEER",
      "last_interaction_at": "2021-07-01T00:00:00Z",
      "is_private": true,
      "can_email": true,
      "locations": [
        "San Francisco",
        "New York"
      ],
      "phone_numbers": [
        "123-456-7890"
      ],
      "email_addresses": [
        "john@doe.com"
      ],
      "urls": [
        {
          "type": "LINKEDIN",
          "value": "https://www.linkedin.com/in/johndoe"
        }
      ],
      "tags": [
        "JUNIOR",
        "INTERMEDIATE"
      ],
      "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

remote_id
string

The third-party API ID of the matching object.

company_id
string

If provided, will only return candidate for this company

first_name
string

If provided, will return candidates with this first name

last_name
string

If provided, will return candidates with this last name

tag
string

If provided, will return candidates with this tag

email_addresses
string[]

If provided, will return candidates with these email addresses

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 <= 1000
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.

modified_after
string

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

Response

200
application/json
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
object[]
required