Skip to main content
GET
Get Candidate By Id

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 | null
required

The custom fields related to the model

Example:
raw_data
Raw Data · object | null

This is the Raw data

Example:
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:
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"