Application data model

Updated:

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

FieldTypeRequiredDescription
idstringNo
candidate_idstringNoThe ID of the candidate who is applying (an AtsCandidate ID)
job_idstringNoThe ID of the job being applied to (an AtsJob ID)
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)
applied_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
hired_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rejected_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rejected_reasonstringNo
sourcestringNo
statusenumNoValues: NEW, REVIEWING, SCREENING, SUBMITTED, FIRST_INTERVIEW, SECOND_INTERVIEW, THIRD_INTERVIEW, BACKGROUND_CHECK, OFFERED, ACCEPTED, HIRED, REJECTED, DECLINED, WITHDRAWN
original_statusstringNoThe integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event.
answersAtsApplicationAnswer[]No
answers[].question_idstringYes
answers[].questionstringNo
answers[].answersstring[]Yes
offersAtsOffer[]No
offers[].idstringNo
offers[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].creator_user_idstringNouser id of the recruiter who created the offer (reference to HrisEmployee)
offers[].employee_user_idstringNonewly hired employee id (reference to HrisEmployee)
offers[].sent_atstring (date-time)Nodate the offer was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].accepted_atstring (date-time)Nodate the offer was accepted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].rejected_atstring (date-time)Nodate the offer was rejected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].start_atstring (date-time)Nodate the employee starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
offers[].compensationAtsCompensation[]Nocompensation details for the offer
offers[].compensation[].typeenumNoValues: SALARY, BONUS, STOCK_OPTIONS, EQUITY, OTHER
offers[].compensation[].minnumberNo
offers[].compensation[].maxnumberNo
offers[].compensation[].currencystringNo
offers[].compensation[].frequencyenumNoValues: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK
offers[].statusenumNoValues: CREATED, SENT, ACCEPTED, REJECTED
user_idstringNoHR user/employee ID (reference to HrisEmployee)
metadataAtsMetadata[]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
original_substatusstringNoThe provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)
summarystringNoApplication personal summary (e.g. Pinpoint Personal Summary)

TypeScript

TypeScript
export type AtsApplication = {
	id?: string;
	candidate_id?: string; // The ID of the candidate who is applying (an AtsCandidate ID)
	job_id?: string; // The ID of the job being applied to (an AtsJob ID)
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	applied_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	hired_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	rejected_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	rejected_reason?: string;
	source?: string;
	status?: 'NEW' | 'REVIEWING' | 'SCREENING' | 'SUBMITTED' | 'FIRST_INTERVIEW' | 'SECOND_INTERVIEW' | 'THIRD_INTERVIEW' | 'BACKGROUND_CHECK' | 'OFFERED' | 'ACCEPTED' | 'HIRED' | 'REJECTED' | 'DECLINED' | 'WITHDRAWN';
	original_status?: string; // 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?: [];
	offers?: [];
	user_id?: string; // HR user/employee ID (reference to HrisEmployee)
	metadata?: [];
	original_substatus?: string; // The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)
	summary?: string; // Application personal summary (e.g. Pinpoint Personal Summary)
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAtsApplication = z.object({
	id: z.string().optional(),
	candidate_id: z.string().optional().describe("The ID of the candidate who is applying (an AtsCandidate ID)"),
	job_id: z.string().optional().describe("The ID of the job being applied to (an AtsJob ID)"),
	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)"),
	applied_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	hired_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	rejected_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	rejected_reason: z.string().optional(),
	source: z.string().optional(),
	status: z.enum("NEW", "REVIEWING", "SCREENING", "SUBMITTED", "FIRST_INTERVIEW", "SECOND_INTERVIEW", "THIRD_INTERVIEW", "BACKGROUND_CHECK", "OFFERED", "ACCEPTED", "HIRED", "REJECTED", "DECLINED", "WITHDRAWN").optional(),
	original_status: z.string().optional().describe("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: z.array().optional(),
	offers: z.array().optional(),
	user_id: z.string().optional().describe("HR user/employee ID (reference to HrisEmployee)"),
	metadata: z.array().optional(),
	original_substatus: z.string().optional().describe("The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)"),
	summary: z.string().optional().describe("Application personal summary (e.g. Pinpoint Personal Summary)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AtsApplicationStatus(str, Enum):
	NEW = 'NEW'
	REVIEWING = 'REVIEWING'
	SCREENING = 'SCREENING'
	SUBMITTED = 'SUBMITTED'
	FIRST_INTERVIEW = 'FIRST_INTERVIEW'
	SECOND_INTERVIEW = 'SECOND_INTERVIEW'
	THIRD_INTERVIEW = 'THIRD_INTERVIEW'
	BACKGROUND_CHECK = 'BACKGROUND_CHECK'
	OFFERED = 'OFFERED'
	ACCEPTED = 'ACCEPTED'
	HIRED = 'HIRED'
	REJECTED = 'REJECTED'
	DECLINED = 'DECLINED'
	WITHDRAWN = 'WITHDRAWN'

@dataclasses.dataclass
class AtsApplication:
	id: Optional[str]
	"""The ID of the candidate who is applying (an AtsCandidate ID)"""
	candidate_id: Optional[str]
	"""The ID of the job being applied to (an AtsJob ID)"""
	job_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]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	applied_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	hired_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	rejected_at: Optional[str]
	rejected_reason: Optional[str]
	source: Optional[str]
	status: Optional[AtsApplicationStatus]
	"""The integration's original status.  Mostly used to have your customers chose the application status/stage so that your software can trigger an event."""
	original_status: Optional[str]
	answers: Optional[PropertyAtsApplicationAnswers]
	offers: Optional[PropertyAtsApplicationOffers]
	"""HR user/employee ID (reference to HrisEmployee)"""
	user_id: Optional[str]
	metadata: Optional[PropertyAtsApplicationMetadata]
	"""The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)"""
	original_substatus: Optional[str]
	"""Application personal summary (e.g. Pinpoint Personal Summary)"""
	summary: Optional[str]
Are we missing anything? Let us know
Was this page helpful?