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.The Candidate object
Properties
idStringRequired
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_atStringOptional
When the third party's candidate was created.
remote_updated_atStringOptional
When the third party's candidate was updated.
last_interaction_atStringOptional
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.JSON
{"value": "+3198675309","phone_number_type": "HOME","modified_at": "2021-10-16T00:00:00Z"}
Properties
valueStringOptional
The phone number.
phone_number_typeEnumOptional
The type of phone number. Possible values include:
HOME, WORK, MOBILE, SKYPE, OTHER, or - in cases where there is no clear mapping - the original value passed through.modified_atStringRequired
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.JSON
{"value": "[email protected]","email_address_type": "PERSONAL","modified_at": "2021-10-16T00:00:00Z"}
Properties
valueStringOptional
The email address.
email_address_typeEnumOptional
The type of email address. Possible values include:
PERSONAL, WORK, OTHER, or - in cases where there is no clear mapping - the original value passed through.modified_atStringRequired
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.JSON
{"value": "http://alturl.com/p749b","url_type": "PERSONAL","modified_at": "2021-10-16T00:00:00Z"}
Properties
valueStringOptional
The site's url.
url_typeEnumOptional
The type of site. Possible values include:
PERSONAL, COMPANY, PORTFOLIO, BLOG, SOCIAL_MEDIA, OTHER, JOB_POSTING, or - in cases where there is no clear mapping - the original value passed through.modified_atStringRequired
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.
JSON
{"id": "92e8a369-fffe-430d-b93a-f7e8a16563f1","remote_id": "98796","candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef","job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","applied_at": "2021-10-15T00:00:00Z","rejected_at": "2021-11-15T00:00:00Z","source": "Campus recruiting event","credited_to": "58166795-8d68-4b30-9bfb-bfd402479484","current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea","reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784","remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
candidateStringOptional
The candidate applying.
jobStringOptional
The job being applied for.
applied_atStringOptional
When the application was submitted.
rejected_atStringOptional
When the application was rejected.
sourceStringOptional
The application's source.
credited_toStringOptional
The user credited for this application.
current_stageStringOptional
The application's current stage.
reject_reasonStringOptional
The application's reason for rejection.
remote_was_deletedBooleanRequired
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
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.JSON
{"id": "c640b80b-fac9-409f-aa19-1f9221aec445","remote_id": "11167","file_name": "Candidate Resume","file_url": "http://alturl.com/p749b","candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef","attachment_type": "RESUME","remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
file_nameStringOptional
The attachment's name.
file_urlStringOptional
The attachment's url.
candidateStringOptional
attachment_typeEnumOptional
The attachment's type. Possible values include:
RESUME, COVER_LETTER, OFFER_LETTER, OTHER, or - in cases where there is no clear mapping - the original value passed through.remote_was_deletedBooleanRequired
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
remote_was_deletedBooleanRequired
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
The Candidate object
JSON
{"id": "521b18c2-4d01-4297-b451-19858d07c133","remote_id": "21198","first_name": "Gil","last_name": "Feig","company": "Columbia Dining App.","title": "Software Engineer","remote_created_at": "2021-10-15T00:00:00Z","remote_updated_at": "2021-10-16T00:00:00Z","last_interaction_at": "2021-10-17T00:00:00Z","is_private": true,"can_email": true,"locations": ["San Francisco","New York","Miami"],"phone_numbers": [{"value": "+1234567890","phone_number_type": "MOBILE"}],"email_addresses": [{"value": "[email protected]","email_address_type": "PERSONAL"}],"urls": [{"value": "http://alturl.com/p749b","url_type": "BLOG"}],"tags": ["High-Priority"],"applications": ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments": ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"remote_was_deleted": true,Show advanced fields}
GET
/candidates
Returns a list of Candidate objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
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_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
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.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "521b18c2-4d01-4297-b451-19858d07c133","remote_id": "21198","first_name": "Gil","last_name": "Feig","company": "Columbia Dining App.","title": "Software Engineer","remote_created_at": "2021-10-15T00:00:00Z","remote_updated_at": "2021-10-16T00:00:00Z","last_interaction_at": "2021-10-17T00:00:00Z","is_private": true,"can_email": true,"locations": ["San Francisco","New York","Miami"],"phone_numbers": [{"value": "+1234567890","phone_number_type": "MOBILE"}],"email_addresses": [{"value": "[email protected]","email_address_type": "PERSONAL"}],"urls": [{"value": "http://alturl.com/p749b","url_type": "BLOG"}],"tags": ["High-Priority"],"applications": ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments": ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"remote_was_deleted": true,Show advanced fields}]}
Field support by platform
ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringcompanyStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtitleString
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdataobjectremote_idString
BizMerlinHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtagsArraytitleString
Clockwork
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarraycan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtitleString
Comeet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdataobjectremote_idString
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_interaction_atStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
EngageATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Eploy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtitleString
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarraycan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringcan_emailBooleancompanyStringfirst_nameStringis_privateBooleanlast_interaction_atStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtitleString
Harbour ATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
Homerun
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringfirst_nameStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
iCIMS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdataobjectremote_idString
Infinite BrassRing
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringtagsArray
JobAdder
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atString
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarraycompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atStringremote_idStringremote_updated_atStringtitleString
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]idstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_dataarrayattachmentsAttachment[]idstringremote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectmodified_atstringremote_data