GET
/
api
/
ats
/
v1
/
candidates
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default: false

Include raw data in the response

Response

200 - application/json

The candidate object is used to represent any person who has applied as a candidate.

id
string
required
remote_id
string | null
required

The third-party API ID of the matching object.

modified_at
string
required

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

first_name
string | null
required

The candidate's first name.

last_name
string | null
required

The candidate's last name.

company
string | null
required

The name of the company where candidate has applied.

title
string | null
required

The position for which the candidate has applied

last_interaction_at
string | null
required

The date of the last interaction with the candidate.

is_private
boolean | null
required

Whether the candidate's information is private.

can_email
boolean | null
required

Whether the candidate can be emailed.

locations
string[] | null
required

The location of the candidate.

phone_numbers
string[] | null
required

The candidate's phone numbers.

email_addresses
string[] | null
required

The candidate's email addresses.

urls
object[] | null
required

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

tags
string[] | null
required

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

applications
string[] | null
required

The candidate's applications.

attachments
string[] | null
required

The candidate's attachments.

remote_created_at
string | null
required

When the third party's candidate was created.

remote_updated_at
string | null
required

When the third party's candidate was last updated.

avatar
string | null
required

The candidate's avatar.

raw_data
object | null

This is the Raw data