Order data model

Updated:

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

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstringYesWorkspace ID that this order belongs to (reference to KmsSpace)
connection_idstringYesConnection ID that this order belongs to
webhook_idstringNoWebhook ID that this order belongs to
package_idstringNoAssessment package ID
parametersAssessmentParameterInput[]NoFilled-in answers to the package's parameter questions
parameters[].parameter_idstringNo
parameters[].namestringNoName of parameter
parameters[].inputsstring[]No
target_urlstringNoURL to redirect user to after assessment
statusenumNoThe current state of the assessment order Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED
referencestringNoATS-specific reference ID
application_idstringNoATS application ID
job_idstringNoATS job ID
company_idstringNoATS company ID (reference to AtsCompany)
candidate_idstringNoATS candidate ID
employee_idstringNoATS employee ID
profile_namestringNo
profile_first_namestringNo
profile_last_namestringNo
profile_resume_urlstringNo
profile_ip_addressstringNoXXX.XXX.XXX.XXX
profile_date_of_birthstringNoYYYY-MM-DD
profile_addressesAssessmentAddress[]No
profile_addresses[].address1stringNo
profile_addresses[].address2stringNo
profile_addresses[].citystringNo
profile_addresses[].regionstringNoRegional area (e.g., state in the U.S., province in Canada)
profile_addresses[].region_codestringNoShort form for regional area (e.g., two-letter stateprovince abbreviation)
profile_addresses[].postal_codestringNo
profile_addresses[].countrystringNo
profile_addresses[].country_codestringNoCountry code in ISO 3166 A-2 format
profile_genderenumNoValues: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY
profile_emailsstring[]No
profile_telephonesstring[]No
profile_national_identifierstringNo
profile_social_media_urlsstring[]No
response_completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_expires_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_issued_atstring (date-time)NoDatetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_statusenumNoValues: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED
response_scorenumberNoAssessment score (e.g., 0-100)
response_max_scorenumberNoMaximum possible score
response_urlstringNoURL to view detailed results
response_redirect_urlstringNoURL to redirect the user to complete assessment
response_download_urlsstring[]NoReport download URLs
response_detailsAssessmentResponseDetail[]No
response_details[].titlestringNo
response_details[].textstringNo
response_details[].is_privatebooleanNo
response_details[].is_failed_reasonbooleanNo
response_details[].parameter_idstringNoIn reference to the parameter input
response_details[].download_urlstringNo
response_sourcestringNo
response_attributesAssessmentAttribute[]NoAdditional result attributes
response_attributes[].typeenumYesValues: TEXT, NUMBER, SUB_RESULT
response_attributes[].labelstringYes
response_attributes[].valuestringNoFor TEXT and NUMBER types
response_attributes[].referencestringNoFor SUB_RESULT type
response_attributes[].score_valuenumberNo
response_attributes[].score_maxnumberNo
response_attributes[].statusenumNoFor SUB_RESULT type Values: OPEN, IN_PROGRESS, COMPLETED, FAILED, REJECTED
metadataAssessmentMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe 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[].valueobjectNoThe 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[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo

TypeScript

TypeScript
export type AssessmentOrder = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	workspace_id: string; // Workspace ID that this order belongs to (reference to KmsSpace)
	connection_id: string; // Connection ID that this order belongs to
	webhook_id?: string; // Webhook ID that this order belongs to
	package_id?: string; // Assessment package ID
	parameters?: []; // Filled-in answers to the package's parameter questions
	target_url?: string; // URL to redirect user to after assessment
	status?: 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'; // The current state of the assessment order
	reference?: string; // ATS-specific reference ID
	application_id?: string; // ATS application ID
	job_id?: string; // ATS job ID
	company_id?: string; // ATS company ID (reference to AtsCompany)
	candidate_id?: string; // ATS candidate ID
	employee_id?: string; // ATS employee ID
	profile_name?: string;
	profile_first_name?: string;
	profile_last_name?: string;
	profile_resume_url?: string;
	profile_ip_address?: string; // XXX.XXX.XXX.XXX
	profile_date_of_birth?: string; // YYYY-MM-DD
	profile_addresses?: [];
	profile_gender?: 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY';
	profile_emails?: string[];
	profile_telephones?: string[];
	profile_national_identifier?: string;
	profile_social_media_urls?: string[];
	response_completed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	response_expires_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	response_issued_at?: string-time; // Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	response_status?: 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED';
	response_score?: number; // Assessment score (e.g., 0-100)
	response_max_score?: number; // Maximum possible score
	response_url?: string; // URL to view detailed results
	response_redirect_url?: string; // URL to redirect the user to complete assessment
	response_download_urls?: string[]; // Report download URLs
	response_details?: [];
	response_source?: string;
	response_attributes?: []; // Additional result attributes
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAssessmentOrder = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	workspace_id: z.string().describe("Workspace ID that this order belongs to (reference to KmsSpace)"),
	connection_id: z.string().describe("Connection ID that this order belongs to"),
	webhook_id: z.string().optional().describe("Webhook ID that this order belongs to"),
	package_id: z.string().optional().describe("Assessment package ID"),
	parameters: z.array().optional().describe("Filled-in answers to the package's parameter questions"),
	target_url: z.string().optional().describe("URL to redirect user to after assessment"),
	status: z.enum("OPEN", "IN_PROGRESS", "COMPLETED", "FAILED", "REJECTED").optional().describe("The current state of the assessment order"),
	reference: z.string().optional().describe("ATS-specific reference ID"),
	application_id: z.string().optional().describe("ATS application ID"),
	job_id: z.string().optional().describe("ATS job ID"),
	company_id: z.string().optional().describe("ATS company ID (reference to AtsCompany)"),
	candidate_id: z.string().optional().describe("ATS candidate ID"),
	employee_id: z.string().optional().describe("ATS employee ID"),
	profile_name: z.string().optional(),
	profile_first_name: z.string().optional(),
	profile_last_name: z.string().optional(),
	profile_resume_url: z.string().optional(),
	profile_ip_address: z.string().optional().describe("XXX.XXX.XXX.XXX"),
	profile_date_of_birth: z.string().optional().describe("YYYY-MM-DD"),
	profile_addresses: z.array().optional(),
	profile_gender: z.enum("MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY").optional(),
	profile_emails: z.array().optional(),
	profile_telephones: z.array().optional(),
	profile_national_identifier: z.string().optional(),
	profile_social_media_urls: z.array().optional(),
	response_completed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	response_expires_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	response_issued_at: z.string-time().optional().describe("Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	response_status: z.enum("OPEN", "IN_PROGRESS", "COMPLETED", "FAILED", "REJECTED").optional(),
	response_score: z.number().optional().describe("Assessment score (e.g., 0-100)"),
	response_max_score: z.number().optional().describe("Maximum possible score"),
	response_url: z.string().optional().describe("URL to view detailed results"),
	response_redirect_url: z.string().optional().describe("URL to redirect the user to complete assessment"),
	response_download_urls: z.array().optional().describe("Report download URLs"),
	response_details: z.array().optional(),
	response_source: z.string().optional(),
	response_attributes: z.array().optional().describe("Additional result attributes"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AssessmentOrderStatus(str, Enum):
	OPEN = 'OPEN'
	IN_PROGRESS = 'IN_PROGRESS'
	COMPLETED = 'COMPLETED'
	FAILED = 'FAILED'
	REJECTED = 'REJECTED'

@dataclasses.dataclass
class AssessmentOrderProfile_gender(str, Enum):
	MALE = 'MALE'
	FEMALE = 'FEMALE'
	INTERSEX = 'INTERSEX'
	TRANS = 'TRANS'
	NON_BINARY = 'NON_BINARY'

@dataclasses.dataclass
class AssessmentOrderResponse_status(str, Enum):
	OPEN = 'OPEN'
	IN_PROGRESS = 'IN_PROGRESS'
	COMPLETED = 'COMPLETED'
	FAILED = 'FAILED'
	REJECTED = 'REJECTED'

@dataclasses.dataclass
class AssessmentOrder:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Workspace ID that this order belongs to (reference to KmsSpace)"""
	workspace_id: str
	"""Connection ID that this order belongs to"""
	connection_id: str
	"""Webhook ID that this order belongs to"""
	webhook_id: Optional[str]
	"""Assessment package ID"""
	package_id: Optional[str]
	"""Filled-in answers to the package's parameter questions"""
	parameters: Optional[PropertyAssessmentOrderParameters]
	"""URL to redirect user to after assessment"""
	target_url: Optional[str]
	"""The current state of the assessment order"""
	status: Optional[AssessmentOrderStatus]
	"""ATS-specific reference ID"""
	reference: Optional[str]
	"""ATS application ID"""
	application_id: Optional[str]
	"""ATS job ID"""
	job_id: Optional[str]
	"""ATS company ID (reference to AtsCompany)"""
	company_id: Optional[str]
	"""ATS candidate ID"""
	candidate_id: Optional[str]
	"""ATS employee ID"""
	employee_id: Optional[str]
	profile_name: Optional[str]
	profile_first_name: Optional[str]
	profile_last_name: Optional[str]
	profile_resume_url: Optional[str]
	"""XXX.XXX.XXX.XXX"""
	profile_ip_address: Optional[str]
	"""YYYY-MM-DD"""
	profile_date_of_birth: Optional[str]
	profile_addresses: Optional[PropertyAssessmentOrderProfile_addresses]
	profile_gender: Optional[AssessmentOrderProfile_gender]
	profile_emails: Optional[List[List[str]]]
	profile_telephones: Optional[List[List[str]]]
	profile_national_identifier: Optional[str]
	profile_social_media_urls: Optional[List[List[str]]]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	response_completed_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	response_expires_at: Optional[str]
	"""Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	response_issued_at: Optional[str]
	response_status: Optional[AssessmentOrderResponse_status]
	"""Assessment score (e.g., 0-100)"""
	response_score: Optional[int]
	"""Maximum possible score"""
	response_max_score: Optional[int]
	"""URL to view detailed results"""
	response_url: Optional[str]
	"""URL to redirect the user to complete assessment"""
	response_redirect_url: Optional[str]
	"""Report download URLs"""
	response_download_urls: Optional[List[List[str]]]
	response_details: Optional[PropertyAssessmentOrderResponse_details]
	response_source: Optional[str]
	"""Additional result attributes"""
	response_attributes: Optional[PropertyAssessmentOrderResponse_attributes]
	metadata: Optional[PropertyAssessmentOrderMetadata]
Are we missing anything? Let us know
Was this page helpful?