Offers
TheOffer object is used to represent an offer for a candidate's application specific to a job.The Offer object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
applicationStringOptional
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.
JSON
{"id": "92e8a369-fffe-430d-b93a-f7e8a16563f1","remote_id": "98796","candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef","job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","applied_at": "2021-10-15T00:00:00Z","rejected_at": "2021-11-15T00:00:00Z","source": "Campus recruiting event","credited_to": "58166795-8d68-4b30-9bfb-bfd402479484","current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea","reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784","remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
candidateStringOptional
The candidate applying.
jobStringOptional
The job being applied for.
applied_atStringOptional
When the application was submitted.
rejected_atStringOptional
When the application was rejected.
sourceStringOptional
The application's source.
credited_toStringOptional
The user credited for this application.
current_stageStringOptional
The application's current stage.
reject_reasonStringOptional
The application's reason for rejection.
remote_was_deletedBooleanRequired
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
creatorStringOptional
The user who created the offer.
remote_created_atStringOptional
When the third party's offer was created.
closed_atStringOptional
When the offer was closed.
sent_atStringOptional
When the offer was sent.
start_dateStringOptional
The employment start date on the offer.
statusEnumOptional
The offer's status. Possible values include:
DRAFT, APPROVAL-SENT, APPROVED, SENT, SENT-MANUALLY, OPENED, DENIED, SIGNED, DEPRECATED, or - in cases where there is no clear mapping - the original value passed through.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
The Offer object
JSON
{"id": "dd85625c-6a59-446f-a317-6de64d83bae7","remote_id": "9876","application": "2872ba14-4084-492b-be96-e5eee6fc33ef","creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","remote_created_at": "2021-10-15T00:00:00Z","closed_at": "2021-10-16T00:00:00Z","sent_at": "2021-10-15T00:00:00Z","start_date": "2021-11-15T00:00:00Z","status": "SENT","remote_was_deleted": true,Show advanced fields}
GET
/offers
Returns a list of Offer objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
application_idStringOptional
If provided, will only return offers for this application.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
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
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
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
Which fields should be returned in non-normalized form.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "dd85625c-6a59-446f-a317-6de64d83bae7","remote_id": "9876","application": "2872ba14-4084-492b-be96-e5eee6fc33ef","creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","remote_created_at": "2021-10-15T00:00:00Z","closed_at": "2021-10-16T00:00:00Z","sent_at": "2021-10-15T00:00:00Z","start_date": "2021-11-15T00:00:00Z","status": "SENT","remote_was_deleted": true,Show advanced fields}]}
Field support by platform
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringstatusEnum
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsent_atStringstart_dateStringstatusEnum
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringsent_atStringstart_dateStringstatusEnum
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsent_atStringstatusEnum
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_dataRemoteData[]pathstringdataobjectsent_atStringstart_dateStringstatusEnum
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsent_atStringstart_dateStringstatusEnum
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstatusEnum
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/offers/{id}
Returns an Offer object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"id": "dd85625c-6a59-446f-a317-6de64d83bae7","remote_id": "9876","application": "2872ba14-4084-492b-be96-e5eee6fc33ef","creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","remote_created_at": "2021-10-15T00:00:00Z","closed_at": "2021-10-16T00:00:00Z","sent_at": "2021-10-15T00:00:00Z","start_date": "2021-11-15T00:00:00Z","status": "SENT","remote_was_deleted": true,Show advanced fields}
Field support by platform
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringstatusEnumGreenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsent_atStringstart_dateStringstatusEnumJobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringsent_atStringstart_dateStringstatusEnumLever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsent_atStringstatusEnumOracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_dataRemoteData[]pathstringdataobjectsent_atStringstart_dateStringstatusEnumSAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayclosed_atStringcreatorStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsent_atStringstart_dateStringstatusEnumSmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstatusEnumWorkable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayremote_created_atStringremote_dataRemoteData[]pathstringdataobjectHint: Use the /linked-accounts endpoint to pull platform support information.