Offers
The
Offer
object is used to represent an offer for a candidate's application specific to a job.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
application
UUIDOptional
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
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
candidate
UUIDOptional
The candidate applying.
job
UUIDOptional
The job being applied for.
applied_at
DateTime (ISO 8601)Optional
When the application was submitted.
rejected_at
DateTime (ISO 8601)Optional
When the application was rejected.
offers
ArrayRequired
source
StringOptional
The application's source.
credited_to
UUIDOptional
The user credited for this application.
current_stage
UUIDOptional
The application's current stage.
reject_reason
UUIDOptional
The application's reason for rejection.
remote_was_deleted
BooleanRequired
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
creator
UUIDOptional
The user who created the offer.
remote_created_at
DateTime (ISO 8601)Optional
When the third party's offer was created.
closed_at
DateTime (ISO 8601)Optional
When the offer was closed.
sent_at
DateTime (ISO 8601)Optional
When the offer was sent.
start_date
DateTime (ISO 8601)Optional
The employment start date on the offer.
status
EnumOptional
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_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/offers
https://api.merge.dev/api/ats/v1/offers
US
EU
Returns a list of Offer
objects.
Query & Path Parameters
application_id
StringOptional
If provided, will only return offers for this application.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
creator_id
StringOptional
If provided, will only return offers created by this user.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
remote_id
StringOptional
The API provider's ID for the given object.
show_enum_origins
StringOptional
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 fieldsUse 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
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)remote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)status
EnumGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)remote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumJobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)sent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumJobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayremote_data
RemoteData[]path
stringdata
stringstatus
EnumLever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)creator
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)status
EnumOracle Taleo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)creator
UUIDremote_data
RemoteData[]path
stringdata
stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)creator
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumSmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumTeamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arraycreator
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumWorkable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsent_at
DateTime (ISO 8601)status
EnumGET
/offers/{id}
https://api.merge.dev/api/ats/v1/offers/{id}
US
EU
Returns an Offer
object with the given id
.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
show_enum_origins
StringOptional
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 fieldsUse 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
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)remote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)status
EnumGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)remote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumJobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)sent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumJobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayremote_data
RemoteData[]path
stringdata
stringstatus
EnumLever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)creator
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)status
EnumOracle Taleo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)creator
UUIDremote_data
RemoteData[]path
stringdata
stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)creator
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumSmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumTeamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arraycreator
UUIDremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsent_at
DateTime (ISO 8601)start_date
DateTime (ISO 8601)status
EnumWorkable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayclosed_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringsent_at
DateTime (ISO 8601)status
Enum