Order data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
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) |
workspace_id | string | Yes | Workspace ID that this order belongs to (reference to KmsSpace) |
connection_id | string | Yes | Connection ID that this order belongs to |
webhook_id | string | No | Webhook ID that this order belongs to |
package_id | string | No | Assessment package ID |
parameters | AssessmentParameterInput[] | No | Filled-in answers to the package's parameter questions |
parameters[].parameter_id | string | No | |
parameters[].name | string | No | Name of parameter |
parameters[].inputs | string[] | No | |
target_url | string | No | URL to redirect user to after assessment |
status | enum | No | The current state of the assessment order Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED |
reference | string | No | ATS-specific reference ID |
application_id | string | No | ATS application ID |
job_id | string | No | ATS job ID |
company_id | string | No | ATS company ID (reference to AtsCompany) |
candidate_id | string | No | ATS candidate ID |
employee_id | string | No | ATS employee ID |
profile_name | string | No | |
profile_first_name | string | No | |
profile_last_name | string | No | |
profile_resume_url | string | No | |
profile_ip_address | string | No | XXX.XXX.XXX.XXX |
profile_date_of_birth | string | No | YYYY-MM-DD |
profile_addresses | AssessmentAddress[] | No | |
profile_addresses[].address1 | string | No | |
profile_addresses[].address2 | string | No | |
profile_addresses[].city | string | No | |
profile_addresses[].region | string | No | Regional area (e.g., state in the U.S., province in Canada) |
profile_addresses[].region_code | string | No | Short form for regional area (e.g., two-letter stateprovince abbreviation) |
profile_addresses[].postal_code | string | No | |
profile_addresses[].country | string | No | |
profile_addresses[].country_code | string | No | Country code in ISO 3166 A-2 format |
profile_gender | enum | No | Values: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY |
profile_emails | string[] | No | |
profile_telephones | string[] | No | |
profile_national_identifier | string | No | |
profile_social_media_urls | string[] | No | |
response_completed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
response_expires_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
response_issued_at | string (date-time) | No | Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
response_status | enum | No | Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED |
response_score | number | No | Assessment score (e.g., 0-100) |
response_max_score | number | No | Maximum possible score |
response_url | string | No | URL to view detailed results |
response_redirect_url | string | No | URL to redirect the user to complete assessment |
response_download_urls | string[] | No | Report download URLs |
response_details | AssessmentResponseDetail[] | No | |
response_details[].title | string | No | |
response_details[].text | string | No | |
response_details[].is_private | boolean | No | |
response_details[].is_failed_reason | boolean | No | |
response_details[].parameter_id | string | No | In reference to the parameter input |
response_details[].download_url | string | No | |
response_source | string | No | |
response_attributes | AssessmentAttribute[] | No | Additional result attributes |
response_attributes[].type | enum | Yes | Values: TEXT, NUMBER, SUB_RESULT |
response_attributes[].label | string | Yes | |
response_attributes[].value | string | No | For TEXT and NUMBER types |
response_attributes[].reference | string | No | For SUB_RESULT type |
response_attributes[].score_value | number | No | |
response_attributes[].score_max | number | No | |
response_attributes[].status | enum | No | For SUB_RESULT type Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED |
metadata | AssessmentMetadata[] | 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 |
Are we missing anything? Let us know
Was this page helpful?