Skip to main content
GET
/
api
/
ats
/
v1
/
candidates
/
{id}
Get Candidate By Id
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/candidates/{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"
  },
  "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

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

​
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]"

Response

Successful Response

​
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"
}
​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}
​
first_name
string | null

The candidate's first name.

Example:

"John"

​
last_name
string | null

The candidate's last name.

Example:

"Doe"

​
company
string | null

The name of the company where candidate has applied.

Example:

"Google"

​
title
string | null

The position for which the candidate has applied

Example:

"SOFTWARE ENGINEER"

​
last_interaction_at
string | null

The date of the last interaction with the candidate.

Example:

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

​
is_private
boolean | null

Whether the candidate's information is private.

Example:

true

​
can_email
boolean | null

Whether the candidate can be emailed.

Example:

true

​
locations
string[] | null

The location of the candidate.

Example:

"San Francisco"

​
phone_numbers
string[] | null

The candidate's phone numbers.

Example:

"123-456-7890"

​
email_addresses
string[] | null

The candidate's email addresses.

Example:

"john@doe.com"

​
urls
AtsUrl · object[] | null

The candidate's URLs. This can include a personal website, LinkedIn profile, or other relevant URLs.

Example:
{
  "type": "LINKEDIN",
  "value": "https://www.linkedin.com/in/johndoe"
}
​
tags
string[] | null

The candidate's tags. Tags are used to categorize candidates and can be used to filter candidates in the UI.

Example:

"JUNIOR"

​
applications
any[] | null

The candidate's applications.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
attachments
any[] | null

The candidate's attachments.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
remote_created_at
string | null

When the third party's candidate was created.

Example:

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

​
remote_updated_at
string | null

When the third party's candidate was last updated.

Example:

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

​
avatar
string | null

The candidate's avatar.

Example:

"https://www.example.com/avatar.jpg"