Order data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstring required
Workspace ID that this order belongs to (reference to KmsSpace)
connection_idstring required
Connection ID that this order belongs to
webhook_idstring
Webhook ID that this order belongs to
package_idstring
Assessment package ID
parameters array
Filled-in answers to the package's parameter questions
target_urlstring
URL to redirect user to after assessment
status enum
Valid values:
"OPEN"
"IN_PROGRESS"
"COMPLETED"
"FAILED"
"REJECTED"
referencestring
ATS-specific reference ID
application_idstring
ATS application ID
job_idstring
ATS job ID
company_idstring
ATS company ID (reference to AtsCompany)
candidate_idstring
ATS candidate ID
employee_idstring
ATS employee ID
profile_namestring
profile_first_namestring
profile_last_namestring
profile_resume_urlstring
profile_ip_addressstring
XXX.XXX.XXX.XXX
profile_date_of_birthstring
YYYY-MM-DD
profile_addresses array
profile_gender enum
Valid values:
"MALE"
"FEMALE"
"INTERSEX"
"TRANS"
"NON_BINARY"
profile_emailsstring array
profile_telephonesstring array
profile_national_identifierstring
profile_social_media_urlsstring array
response_completed_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_expires_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_issued_atdate
Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_status enum
Valid values:
"OPEN"
"IN_PROGRESS"
"COMPLETED"
"FAILED"
"REJECTED"
response_scorenumber
Assessment score (e.g., 0-100)
response_max_scorenumber
Maximum possible score
response_urlstring
URL to view detailed results
response_redirect_urlstring
URL to redirect the user to complete assessment
response_download_urlsstring array
Report download URLs
response_details array
response_sourcestring
response_attributes array
Additional result attributes
Are we missing anything? Let us know
Was this page helpful?