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
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
first_nameStringOptional
The candidate's first name.
last_nameStringOptional
The candidate's last name.
companyStringOptional
The candidate's current company.
titleStringOptional
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_privateBooleanOptional
Whether or not the candidate is private.
can_emailBooleanOptional
Whether or not the candidate can be emailed.
locationsArrayOptional
The candidate's locations.
phone_numbersPhoneNumber[]Required
The PhoneNumber object
The
PhoneNumber object is used to represent a candidate's phone number.Properties
valueStringOptional
The phone number.
phone_number_typeEnumOptional
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
valueStringOptional
The email address.
email_address_typeEnumOptional
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
valueStringOptional
The site's url.
url_typeEnumOptional
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
tagsArrayRequired
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
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
candidateUUIDOptional
The candidate applying.
jobUUIDOptional
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.
sourceStringOptional
The application's source.
credited_toUUIDOptional
The user credited for this application.
current_stageUUIDOptional
The application's current stage.
reject_reasonUUIDOptional
The application's reason for rejection.
remote_was_deletedBooleanRequired
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
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
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
file_nameStringOptional
The attachment's name.
file_urlStringOptional
The attachment's url.
candidateUUIDOptional
attachment_typeEnumOptional
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_deletedBooleanRequired
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
remote_was_deletedBooleanRequired
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
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.
cursorStringOptional
The pagination cursor value.
email_addressesStringOptional
If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
first_nameStringOptional
If provided, will only return candidates with this first name.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
last_nameStringOptional
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
tagsStringOptional
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
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtagsArraytitleString
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Breezy
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Bullhorn
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
CATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
ClayHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
applicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Clockwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Comeet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Cornerstone TalentLink
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
EngageATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Eploy
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Fountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringcan_emailBooleancompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Harbour ATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Homerun
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
HR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
iCIMS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Infinite BrassRing
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
JazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtagsArray
JobAdder
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
JobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Jobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Lano
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Lever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarraycompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Oracle Fusion - Recruiting Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
phone_numbersPhoneNumber[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleancreated_atstringmodified_atstringfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Oracle Taleo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_to