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

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

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

first_nameString
The candidate's first name.

last_nameString
The candidate's last name.

companyString
The candidate's current company.

titleString
The candidate's current title.

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

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

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

is_privateBoolean
Whether or not the candidate is private.

can_emailBoolean
Whether or not the candidate can be emailed.

locationsArray
The candidate's locations.

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

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

valueString
The phone number.

phone_number_typeEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

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

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

valueString
The email address.

email_address_typeEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

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

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

valueString
The site's url.

url_typeEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

tagsArray
Array of Tag names as strings.

applicationsApplication[]
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

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

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

candidateUUID
The candidate applying.

jobUUID
The job being applied for.

applied_atDateTime (ISO 8601)
When the application was submitted.

rejected_atDateTime (ISO 8601)
When the application was rejected.

offersArray

sourceString
The application's source.

credited_toUUID
The user credited for this application.

screening_question_answersScreeningQuestionAnswer[]

current_stageUUID
The application's current stage.

reject_reasonUUID
The application's reason for rejection.

remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

remote_dataRemoteData[]

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

idUUID

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

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

file_nameString
The attachment's name.

file_urlString
The attachment's url.

candidateUUID

attachment_typeEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

remote_dataRemoteData[]

remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties

pathString
The third-party API path that is being called.

dataAny
The data returned from the third-party for this object in its original, unnormalized format.


GET
/candidates

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

US
EU
APAC

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
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

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

include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

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
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Ashby
Ashby
Avature
Avature
BambooHR
BambooHR
Breezy
Breezy
Bullhorn
Bullhorn
CATS
CATS
ClayHR
ClayHR
Clockwork
Clockwork
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
d.Vinci
d.Vinci
Easycruit
Easycruit
EngageATS
EngageATS
Eploy
Eploy
Flatchr
Flatchr
Fountain
Fountain
Gem
Gem
Greenhouse
Greenhouse
Harbour ATS
Harbour ATS
Homerun
Homerun
HR Cloud
HR Cloud
iCIMS
iCIMS
Infinite BrassRing
Infinite BrassRing
JazzHR
JazzHR
JobAdder
JobAdder
JobDiva
JobDiva
JobScore
JobScore
Jobvite
Jobvite
Join
Join
Lano
Lano
Lever
Lever