Candidates
The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

first_nameString
Optional
The candidate's first name.

last_nameString
Optional
The candidate's last name.

companyString
Optional
The candidate's current company.

titleString
Optional
The candidate's current title.

remote_created_atDateTime (ISO 8601)
Optional
When the third party's candidate was created.

remote_updated_atDateTime (ISO 8601)
Optional
When the third party's candidate was updated.

last_interaction_atDateTime (ISO 8601)
Optional
When the most recent interaction with the candidate occurred.

is_privateBoolean
Optional
Whether or not the candidate is private.

can_emailBoolean
Optional
Whether or not the candidate can be emailed.

locationsArray
Optional
The candidate's locations.

phone_numbersPhoneNumber[]
Required
The PhoneNumber object
The PhoneNumber object is used to represent a candidate's phone number.
Properties

valueString
Optional
The phone number.

phone_number_typeEnum
Optional
The type of phone number. Possible values include: HOME, WORK, MOBILE, SKYPE, OTHER. In cases where there is no clear mapping, the original value passed through will be returned.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

email_addressesEmailAddress[]
Required
The EmailAddress object
The EmailAddress object is used to represent a candidate's email address.
Properties

valueString
Optional
The email address.

email_address_typeEnum
Optional
The type of email address. Possible values include: PERSONAL, WORK, OTHER. In cases where there is no clear mapping, the original value passed through will be returned.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

urlsUrl[]
Required
The Url object
The Url object is used to represent hyperlinks associated with the parent model.
Properties

valueString
Optional
The site's url.

url_typeEnum
Optional
The type of site. Possible values include: PERSONAL, COMPANY, PORTFOLIO, BLOG, SOCIAL_MEDIA, OTHER, JOB_POSTING. In cases where there is no clear mapping, the original value passed through will be returned.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

tagsArray
Required
Array of Tag names as strings.

applicationsApplication[]
Required
Array of Application object IDs.
The Application object
The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

candidateUUID
Optional
The candidate applying.

jobUUID
Optional
The job being applied for.

applied_atDateTime (ISO 8601)
Optional
When the application was submitted.

rejected_atDateTime (ISO 8601)
Optional
When the application was rejected.

sourceString
Optional
The application's source.

credited_toUUID
Optional
The user credited for this application.

current_stageUUID
Optional
The application's current stage.

reject_reasonUUID
Optional
The application's reason for rejection.

remote_was_deletedBoolean
Required

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

attachmentsAttachment[]
Required
Array of Attachment object IDs.
The Attachment object
The Attachment object is used to represent a file attached to a candidate.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

file_nameString
Optional
The attachment's name.

file_urlString
Optional
The attachment's url.

candidateUUID
Optional

attachment_typeEnum
Optional
The attachment's type. Possible values include: RESUME, COVER_LETTER, OFFER_LETTER, OTHER. In cases where there is no clear mapping, the original value passed through will be returned.

remote_was_deletedBoolean
Required

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/candidates

https://api.merge.dev/api/ats/v1/candidates

US
EU

Returns a list of Candidate objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

email_addressesString
Optional
If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

first_nameString
Optional
If provided, will only return candidates with this first name.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

last_nameString
Optional
If provided, will only return candidates with this last name.

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

tagsString
Optional
If provided, will only return candidates with these tags; multiple tags can be separated by commas.

Field support by integration
See all supported fields
ApplicantStack
ApplicantStack
Ashby
Ashby
BambooHR
BambooHR
Breezy
Breezy
Bullhorn
Bullhorn
CATS
CATS
ClayHR
ClayHR
Clockwork
Clockwork
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
EngageATS
EngageATS
Eploy
Eploy
Fountain
Fountain
Greenhouse
Greenhouse
Harbour ATS
Harbour ATS
Homerun
Homerun
HR Cloud
HR Cloud
iCIMS
iCIMS
Infinite BrassRing
Infinite BrassRing
JazzHR
JazzHR
JobAdder
JobAdder
JobScore
JobScore
Jobvite
Jobvite
Lano
Lano
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo