{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/GetAtsOffersPositiveResponse", "title": "GetAtsOffersPositiveResponse", "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "data": { "type": "object", "properties": { "next": { "type": [ "string", "null" ], "description": "Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages." }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": [ "string", "null" ], "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." }, "status": { "type": [ "string", "null" ], "enum": [ "ACCEPTED", "DECLINED", "SENT", "APPROVED", "DRAFT", "ABANDONED" ], "description": "The offer\u2019s current status. The usual flow of statuses is as follows:\n`DRAFT` -> `APPROVED` -> `SENT` -> `ACCEPTED` or `DECLINED`.\n\nPlease note that not all systems will expose all statuses. For example, most systems do not include the `APPROVED` status\n\n- `ACCEPTED`: The offer was accepted by the candidate.\n- `DECLINED`: The offer was declined by the candidate.\n- `SENT`: The offer was sent to the candidate.\n- `APPROVED`: The draft was approved.\n- `DRAFT`: The offer is a draft and has not yet been sent to the candidate.\n- `ABANDONED`: The offer has expired or is no longer valid and should not be considered.\n" }, "employment_start_date": { "description": "The date when the employment described by the offer starts. Can be in the past or future.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "application_id": { "type": [ "string", "null" ], "description": "The Kombo ID of the application this interview belongs to. The ID can be used to retrieve the application from the `get applications` endpoint." }, "custom_fields": { "type": [ "object", "null" ], "additionalProperties": true, "description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)" }, "integration_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique ID of this object." }, "key": { "type": "string", "description": "The key of the field in the remote system." }, "type": { "type": "string", "enum": [ "DEFAULT", "CUSTOM" ], "description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user." }, "value": { "type": "null", "description": "The field's value." }, "label": { "type": [ "string", "null" ], "description": "The label of the field. (not always available)" } }, "required": [ "id", "key", "type", "label" ] }, "description": "An array of selected passthrough integration fields. [Read more](/integration-fields)", "examples": [ [ { "id": "5NVFhMpB9Ah6by44tzNjZLyE", "key": "firstName", "type": "DEFAULT", "value": "Frank", "label": "First Name" }, { "id": "8nuajYpoRd5GnxEQaaWKUDYQ", "key": "customTshirtSize", "type": "CUSTOM", "value": "XL", "label": "T-Shirt Size" } ] ] }, "changed_at": { "description": "The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.", "type": "string", "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "remote_deleted_at": { "description": "The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "remote_created_at": { "description": "The date and time the object was created in the remote system.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "remote_updated_at": { "description": "A timestamp retrieved from the remote system, describing when the resource was last updated.", "type": [ "string", "null" ], "format": "date-time", "externalDocs": { "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString" } }, "remote_data": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it." }, "application": { "type": [ "object", "null" ], "properties": { "candidate": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": "string", "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." }, "first_name": { "type": [ "string", "null" ], "description": "First name of the candidate." }, "last_name": { "type": [ "string", "null" ], "description": "Last name of the candidate." }, "email_addresses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "email_address": { "type": [ "string", "null" ], "pattern": "^(?!\\.)(?!.*\\.\\.)([\\w'+-.]*)[\\w+-]@([\\da-z][\\da-z-]*\\.)+[a-z]{2,}$" }, "type": { "type": [ "string", "null" ], "description": "Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`." } }, "required": [ "type" ] }, "default": [], "description": "A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out." } }, "required": [ "id", "remote_id", "first_name", "last_name" ], "examples": [ { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32", "first_name": "John", "last_name": "Doe", "email_addresses": [ { "email_address": "john.doe@example.com", "type": "PRIVATE" } ] } ] }, "job": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing." }, "remote_id": { "type": "string", "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key." }, "name": { "type": [ "string", "null" ], "description": "Title of the job." } }, "required": [ "id", "remote_id", "name" ], "examples": [ { "id": "H5daSm8e85Dmvmne3wLeCPhX", "remote_id": "32", "name": "Backend Engineer" } ] } }, "required": [ "candidate", "job" ] } }, "required": [ "id", "remote_id", "status", "employment_start_date", "application_id", "custom_fields", "integration_fields", "changed_at", "remote_deleted_at", "remote_created_at", "remote_updated_at", "remote_data", "application" ] } } }, "required": [ "next", "results" ], "examples": [ { "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=", "results": [ { "id": "76bab8LKuFtqpZ89mofCPMHX", "remote_id": "6", "status": "ACCEPTED", "employment_start_date": "2022-08-07T14:01:29.196Z", "application_id": "BAkbueBMBusj9Bg7L1Wps3AR", "custom_fields": {}, "integration_fields": [], "changed_at": "2022-08-07T14:01:29.196Z", "remote_deleted_at": null, "remote_created_at": "2022-08-07T14:01:29.196Z", "remote_updated_at": "2022-08-07T14:01:29.196Z", "remote_data": null, "application": { "candidate": { "id": "26vafvWSRmbhNcxJYqjCzuJg", "remote_id": "32", "first_name": "John", "last_name": "Doe", "email_addresses": [ { "email_address": "john.doe@example.com", "type": "PRIVATE" } ] }, "job": { "id": "H5daSm8e85Dmvmne3wLeCPhX", "remote_id": "32", "name": "Backend Engineer" } } } ] } ] } }, "required": [ "status", "data" ] }