Merge · Schema
Offer
# The Offer Object ### Description The `Offer` object is used to represent an offer for a candidate's application specific to a job. ### Usage Example Fetch from the `LIST Offers` endpoint and filter by `ID` to show all offers.
IntegrationsPlatformUnified APIAgent HandlerLLM Gateway
Properties
| Name | Type | Description |
|---|---|---|
| id | string | |
| remote_id | stringnull | The third-party API ID of the matching object. |
| created_at | string | The datetime that this object was created by Merge. |
| modified_at | string | The datetime that this object was modified by Merge. |
| application | stringnull | The application who is receiving the offer. |
| creator | stringnull | The user who created the offer. |
| remote_created_at | stringnull | When the third party's offer was created. |
| closed_at | stringnull | When the offer was closed. |
| sent_at | stringnull | When the offer was sent. |
| start_date | stringnull | The employment start date on the offer. |
| status | object | The offer's status. |
| remote_was_deleted | boolean | 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 cove |
| field_mappings | object | |
| remote_data | arraynull |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Offer",
"title": "Offer",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "The third-party API ID of the matching object."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime that this object was created by Merge."
},
"modified_at": {
"type": "string",
"format": "date-time",
"description": "The datetime that this object was modified by Merge."
},
"application": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The application who is receiving the offer."
},
"creator": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The user who created the offer."
},
"remote_created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the third party's offer was created."
},
"closed_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the offer was closed."
},
"sent_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the offer was sent."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The employment start date on the offer."
},
"status": {
"oneOf": [
{
"$ref": "#/components/schemas/OfferStatusEnum"
},
{
"type": "null"
}
],
"description": "The offer's status."
},
"remote_was_deleted": {
"type": "boolean",
"description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
},
"field_mappings": {
"oneOf": [
{
"$ref": "#/components/schemas/OfferFieldMappings"
},
{
"type": "null"
}
]
},
"remote_data": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/RemoteData"
}
}
},
"description": "# The Offer Object\n### Description\nThe `Offer` object is used to represent an offer for a candidate's application specific to a job.\n### Usage Example\nFetch from the `LIST Offers` endpoint and filter by `ID` to show all offers."
}