Applications
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.

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

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

candidateUUID
Optional
The candidate applying.
The Candidate object
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.

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

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

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

email_addressesEmailAddress[]
Required

urlsUrl[]
Required

tagsArray
Required
Array of Tag names as strings.

applicationsApplication[]
Required
Array of Application object IDs.

attachmentsAttachment[]
Required
Array of Attachment object IDs.

remote_was_deletedBoolean
Required
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
Optional

remote_dataRemoteData[]
Optional

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.

offersArray
Required

sourceString
Optional
The application's source.

credited_toUUID
Optional
The user credited for this application.

screening_question_answersScreeningQuestionAnswer[]
Required
The ScreeningQuestionAnswer object
The ScreeningQuestionAnswer object is used to represent candidate responses to a screening question, for a specific application.
Properties

idUUID
Required

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

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

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

questionUUID
Optional
The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding screening_question_answers.question to the expand query parameter.

answerString
Optional
The candidate’s response to the screening question.

remote_was_deletedBoolean
Required
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.

current_stageUUID
Optional
The application's current stage.

reject_reasonUUID
Optional
The application's reason for rejection.

remote_was_deletedBoolean
Required
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
Optional

remote_dataRemoteData[]
Optional


GET
/applications

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

US
EU
APAC

Returns a list of Application objects.


Query & Path Parameters

candidate_idString
Optional
If provided, will only return applications for this candidate.

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.

credited_to_idString
Optional
If provided, will only return applications credited to this user.

current_stage_idString
Optional
If provided, will only return applications at this interview stage.

cursorString
Optional
The pagination cursor value.

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

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).

job_idString
Optional
If provided, will only return applications for this job.

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.

reject_reason_idString
Optional
If provided, will only return applications with this reject reason.

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

sourceString
Optional
If provided, will only return applications with this source.

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
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
JobDiva
JobDiva
JobScore
JobScore
Jobvite
Jobvite
Join
Join
Lever
Lever
Occupop
Occupop
Onlyfy
Onlyfy
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Taleez
Taleez
TalentLyft
TalentLyft
Teamtailor
Teamtailor
Tellent
Tellent
Traffit
Traffit
Tribepad
Tribepad
UKG Pro Recruiting
UKG Pro Recruiting
Workable
Workable
Workday
Workday
Zoho Recruit
Zoho Recruit
POST
/applications

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

US
EU
APAC

Creates an Application object with the given values. For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application.

See our Help Center article for detailed support per integration.


Query & Path Parameters

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.

remote_user_idString
Required
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.

candidateUUID
The candidate applying. Must pass in a valid Merge ID, which can be obtained from the id field in the Candidate object. For specified integrations, you may pass in the Candidate model directly and Merge will automatically handle deduplication of existing objects.

jobUUID
The job being applied for. Must pass in a valid Merge ID, which can be obtained from the id field in the Job object.

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. Must pass in a valid Merge ID, which can be obtained from the id field in the RemoteUser object.

screening_question_answersArray

current_stageUUID
The application's current stage. Must pass in a valid Merge ID, which can be obtained from the id field in the JobInterviewStage object.

reject_reasonUUID
The application's reason for rejection. Must pass in a valid Merge ID, which can be obtained from the id field in the RejectReason object.

remote_template_idString

integration_paramsObject

linked_account_paramsObject

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Avature
Avature
BambooHR
BambooHR
Bullhorn
Bullhorn
Clockwork
Clockwork
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
Eploy
Eploy
Greenhouse
Greenhouse
Harbour ATS
Harbour ATS
iCIMS
iCIMS
JazzHR
JazzHR
JobAdder
JobAdder
Jobvite
Jobvite
Lever
Lever
Oracle Taleo
Oracle Taleo
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Taleez
Taleez
Teamtailor
Teamtailor
UKG Pro Recruiting
UKG Pro Recruiting
Workable
Workable
Workday
Workday
To include the correct model fields when making POST requests, use the GET /applications/meta/post endpoint. Learn more in our /meta guide.
GET
/applications/{id}

https://api.merge.dev/api/ats/v1/applications/{id}

US
EU
APAC

Returns an Application object with the given id.


Query & Path Parameters

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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
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
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
JobDiva
JobDiva
JobScore
JobScore
Jobvite
Jobvite
Join
Join
Lever
Lever
Occupop
Occupop
Onlyfy
Onlyfy
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Taleez
Taleez
TalentLyft
TalentLyft
Teamtailor
Teamtailor
Tellent
Tellent
Traffit
Traffit
Tribepad
Tribepad
UKG Pro Recruiting
UKG Pro Recruiting
Workable
Workable
Workday
Workday
Zoho Recruit
Zoho Recruit
POST
/applications/{id}/change-stage
Beta

https://api.merge.dev/api/ats/v1/applications/{id}/change-stage

US
EU
APAC

Updates the current_stage field of an Application object


Query & Path Parameters

idUUID
Required

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters

job_interview_stageUUID
Optional
The interview stage to move the application to. Must pass in a valid Merge ID, which can be obtained from the id field in the Job_interview_stage object.

remote_user_idString
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
BambooHR
BambooHR
Breezy
Breezy
Bullhorn
Bullhorn
Fountain
Fountain
Greenhouse
Greenhouse
JobAdder
JobAdder
Lever
Lever
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Workable
Workable
GET
/applications/meta/post

https://api.merge.dev/api/ats/v1/applications/meta/post

US
EU
APAC

Returns metadata for Application POSTs.


Query & Path Parameters

application_remote_template_idString
Optional
The template ID associated with the nested application in the request.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Avature
Avature
BambooHR
BambooHR
Breezy
Breezy
Bullhorn
Bullhorn
Clockwork
Clockwork
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
Eploy
Eploy
Fountain
Fountain
Greenhouse
Greenhouse
Harbour ATS
Harbour ATS
iCIMS
iCIMS
JazzHR
JazzHR
JobAdder
JobAdder
Jobvite
Jobvite
Lever
Lever
Oracle Taleo
Oracle Taleo
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Taleez
Taleez
Teamtailor
Teamtailor
UKG Pro Recruiting
UKG Pro Recruiting
Workable
Workable
Workday
Workday