Offers
The
Offer object is used to represent an offer for a candidate's application specific to a job.Properties
idUUIDremote_idStringThe 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.
applicationUUIDThe application who is receiving the offer.
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
idUUIDremote_idStringThe 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.
candidateUUIDThe candidate applying.
jobUUIDThe job being applied for.
applied_atDateTime (ISO 8601)When the application was submitted.
rejected_atDateTime (ISO 8601)When the application was rejected.
offersArraysourceStringThe application's source.
credited_toUUIDThe user credited for this application.
screening_question_answersScreeningQuestionAnswer[]current_stageUUIDThe application's current stage.
reject_reasonUUIDThe application's reason for rejection.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]creatorUUIDThe user who created the offer.
remote_created_atDateTime (ISO 8601)When the third party's offer was created.
closed_atDateTime (ISO 8601)When the offer was closed.
sent_atDateTime (ISO 8601)When the offer was sent.
start_dateDateTime (ISO 8601)The employment start date on the offer.
statusEnumThe offer's status. Possible values include:
DRAFT, APPROVAL-SENT, APPROVED, SENT, SENT-MANUALLY, OPENED, DENIED, SIGNED, DEPRECATED. 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_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/offers
https://api.merge.dev/api/ats/v1/offers
US
EU
APAC
Returns a list of Offer objects.
Query & path parameters
application_idStringOptional
If provided, will only return offers for this application.
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.
creator_idStringOptional
If provided, will only return offers created by this user.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)remote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)statusEnum
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)remote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnum
iCIMS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringsourcestringcurrent_stagestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)statusEnum
Jobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringremote_dataRemoteData[]pathstringdatastringstatusEnum
Lever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)creatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)statusEnum
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
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringcurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)creatorUUIDremote_dataRemoteData[]pathstringdatastringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnum
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringclosed_atDateTime (ISO 8601)creatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnum
SmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDcandidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum
Teamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringcreatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnum
UKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringclosed_atDateTime (ISO 8601)creatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)
Workable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDcandidatestringjobstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastring
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsent_atDateTime (ISO 8601)statusEnumGET
/offers/{id}
https://api.merge.dev/api/ats/v1/offers/{id}
US
EU
APAC
Returns an Offer object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)remote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)statusEnumGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)remote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnumiCIMS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringsourcestringcurrent_stagestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)statusEnumJobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringremote_dataRemoteData[]pathstringdatastringstatusEnumLever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)creatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)statusEnumOracle Taleo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringcurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)creatorUUIDremote_dataRemoteData[]pathstringdatastringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnumSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringclosed_atDateTime (ISO 8601)creatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnumSmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDcandidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumTeamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringcreatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)statusEnumUKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringclosed_atDateTime (ISO 8601)creatorUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringsent_atDateTime (ISO 8601)start_dateDateTime (ISO 8601)Workable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDcandidatestringjobstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
applicationUUIDremote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringclosed_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringsent_atDateTime (ISO 8601)statusEnum