Application data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
candidate_id | string | No | The ID of the candidate who is applying (an AtsCandidate ID) |
job_id | string | No | The ID of the job being applied to (an AtsJob ID) |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
applied_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
hired_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
rejected_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
rejected_reason | string | No | |
source | string | No | |
status | enum | No | Values: NEW, REVIEWING, SCREENING, SUBMITTED, FIRST_INTERVIEW, SECOND_INTERVIEW, THIRD_INTERVIEW, BACKGROUND_CHECK, OFFERED, ACCEPTED, HIRED, REJECTED, DECLINED, WITHDRAWN |
original_status | string | No | The integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event. |
answers | AtsApplicationAnswer[] | No | |
answers[].question_id | string | Yes | |
answers[].question | string | No | |
answers[].answers | string[] | Yes | |
offers | AtsOffer[] | No | |
offers[].id | string | No | |
offers[].created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].creator_user_id | string | No | user id of the recruiter who created the offer (reference to HrisEmployee) |
offers[].employee_user_id | string | No | newly hired employee id (reference to HrisEmployee) |
offers[].sent_at | string (date-time) | No | date the offer was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].accepted_at | string (date-time) | No | date the offer was accepted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].rejected_at | string (date-time) | No | date the offer was rejected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].start_at | string (date-time) | No | date the employee starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
offers[].compensation | AtsCompensation[] | No | compensation details for the offer |
offers[].compensation[].type | enum | No | Values: SALARY, BONUS, STOCK_OPTIONS, EQUITY, OTHER |
offers[].compensation[].min | number | No | |
offers[].compensation[].max | number | No | |
offers[].compensation[].currency | string | No | |
offers[].compensation[].frequency | enum | No | Values: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK |
offers[].status | enum | No | Values: CREATED, SENT, ACCEPTED, REJECTED |
user_id | string | No | HR user/employee ID (reference to HrisEmployee) |
metadata | AtsMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
original_substatus | string | No | The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage) |
summary | string | No | Application personal summary (e.g. Pinpoint Personal Summary) |
Are we missing anything? Let us know
Was this page helpful?