Offers
The Offer object is used to represent an offer for a candidate's application specific to a job.
Properties

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

applicationUUID
Optional
The 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

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

candidateUUID
Optional
The candidate applying.

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.

current_stageUUID
Optional
The application's current stage.

reject_reasonUUID
Optional
The application's reason for rejection.

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

creatorUUID
Optional
The user who created the offer.

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

closed_atDateTime (ISO 8601)
Optional
When the offer was closed.

sent_atDateTime (ISO 8601)
Optional
When the offer was sent.

start_dateDateTime (ISO 8601)
Optional
The employment start date on the offer.

statusEnum
Optional
The 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.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/offers

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

US
EU

Returns a list of Offer objects.


Query & Path Parameters

application_idString
Optional
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_idString
Optional
If provided, will only return offers created by this user.

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
Whether to include data that was marked as deleted by third party webhooks.

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

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_fieldsString
Optional
Deprecated. Use show_enum_origins.

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

show_enum_originsString
Optional
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
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Greenhouse
Greenhouse
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Taleo
Oracle Taleo
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Workable
Workable
Workday
Workday
GET
/offers/{id}

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

US
EU

Returns an Offer 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.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
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
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Greenhouse
Greenhouse
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Taleo
Oracle Taleo
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Workable
Workable
Workday
Workday