Job 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)
namestringNoThe job's title
descriptionstringNo
recruiter_idsstring[]No
hiring_manager_idsstring[]No
hiring_managersAtsReference[]No
hiring_managers[].idstringNo
hiring_managers[].namestringNo
statusenumNoValues: ARCHIVED, PENDING, DRAFT, OPEN, CLOSED
closed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
addressesAtsAddress[]No
addresses[].address1stringNo
addresses[].address2stringNo
addresses[].citystringNo
addresses[].regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
addresses[].region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
addresses[].postal_codestringNo
addresses[].countrystringNo
addresses[].country_codestringNoCountry code for the country, in ISO 3166 A-2 format
compensationAtsCompensation[]No
compensation[].typeenumNoValues: SALARY, BONUS, STOCK_OPTIONS, EQUITY, OTHER
compensation[].minnumberNo
compensation[].maxnumberNo
compensation[].currencystringNo
compensation[].frequencyenumNoValues: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK
employment_typeenumNoValues: FULL_TIME, PART_TIME, CONTRACTOR, INTERN, CONSULTANT, VOLUNTEER, CASUAL, SEASONAL, FREELANCE, OTHER
remotebooleanNo
language_localestringNoPreferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)
public_job_urlsstring[]NoURLs for pages containing public listings for the job
number_of_openingsnumberNoNumber of openings for the job
company_idstringNoid value of the company associated with the job in the ATS (reference to AtsCompany)
questionsAtsJobQuestion[]No
questions[].idstringNo
questions[].questionstringYes
questions[].requiredbooleanNo
questions[].descriptionstringNo
questions[].promptstringNo
questions[].typeenumYesValues: TEXT, NUMBER, DATE, BOOLEAN, MULTIPLE_CHOICE, FILE, TEXTAREA, MULTIPLE_SELECT, UNIVERSITY, YES_NO, CURRENCY, URL
questions[].optionsstring[]No
questions[].min_lengthnumberNominimum answer length (TEXT)
questions[].max_lengthnumberNomaximum answer length (TEXT)
questions[].min_valuenumberNominimum answer value (NUMBER)
questions[].max_valuenumberNomaximum answer value (NUMBER)
questions[].min_atstring (date-time)Noearliest allowed answer (DATE) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
questions[].max_atstring (date-time)Nolatest allowed answer (DATE) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
questions[].parent_idstringNoid of the question in this job's questions list that this question depends on
questions[].parent_answer_valuesstring[]Noonly ask this question when the parent question's answer is one of these
postingsAtsJobPosting[]NoPublic job postings
postings[].idstringNo
postings[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
postings[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
postings[].posting_urlstringNo
postings[].namestringNojob-post-specific name
postings[].descriptionstringNojob-post-specific description
postings[].addressAtsJobPosting_addressNojob-post-specific address
postings[].address.address1stringNo
postings[].address.address2stringNo
postings[].address.citystringNo
postings[].address.regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
postings[].address.region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
postings[].address.postal_codestringNo
postings[].address.countrystringNo
postings[].address.country_codestringNoCountry code for the country, in ISO 3166 A-2 format
postings[].locationstringNojob-post-specific location
postings[].is_activebooleanNo
groupsAtsGroup[]NoThe departments/divisions/teams that this job belongs to
groups[].idstringNo
groups[].namestringNo
groups[].typeenumNoValues: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS_UNIT, BRANCH, SUB_DEPARTMENT
openingsAtsJobOpening[]No
openings[].statusenumNoValues: OPEN, CLOSED
openings[].opened_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
openings[].closed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
openings[].application_idstringNopoints to an application
openings[].close_reasonstringNo
minimum_experience_yearsnumberNo
minimum_degreestringNo
skillsstring[]No
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
user_idstringNoUser id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)
industrystringNo
summarystringNoShort job blurb (distinct from full description when both exist)

TypeScript

TypeScript
export type AtsJob = {
	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)
	name?: string; // The job's title
	description?: string;
	recruiter_ids?: string[];
	hiring_manager_ids?: string[];
	hiring_managers?: [];
	status?: 'ARCHIVED' | 'PENDING' | 'DRAFT' | 'OPEN' | 'CLOSED';
	closed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	addresses?: [];
	compensation?: [];
	employment_type?: 'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER';
	remote?: boolean;
	language_locale?: string; // Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)
	public_job_urls?: string[]; // URLs for pages containing public listings for the job
	number_of_openings?: number; // Number of openings for the job
	company_id?: string; // id value of the company associated with the job in the ATS (reference to AtsCompany)
	questions?: [];
	postings?: []; // Public job postings
	groups?: []; // The departments/divisions/teams that this job belongs to
	openings?: [];
	minimum_experience_years?: number;
	minimum_degree?: string;
	skills?: string[];
	metadata?: [];
	user_id?: string; // User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)
	industry?: string;
	summary?: string; // Short job blurb (distinct from full description when both exist)
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAtsJob = 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)"),
	name: z.string().optional().describe("The job's title"),
	description: z.string().optional(),
	recruiter_ids: z.array().optional(),
	hiring_manager_ids: z.array().optional(),
	hiring_managers: z.array().optional(),
	status: z.enum("ARCHIVED", "PENDING", "DRAFT", "OPEN", "CLOSED").optional(),
	closed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	addresses: z.array().optional(),
	compensation: z.array().optional(),
	employment_type: z.enum("FULL_TIME", "PART_TIME", "CONTRACTOR", "INTERN", "CONSULTANT", "VOLUNTEER", "CASUAL", "SEASONAL", "FREELANCE", "OTHER").optional(),
	remote: z.boolean().optional(),
	language_locale: z.string().optional().describe("Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)"),
	public_job_urls: z.array().optional().describe("URLs for pages containing public listings for the job"),
	number_of_openings: z.number().optional().describe("Number of openings for the job"),
	company_id: z.string().optional().describe("id value of the company associated with the job in the ATS (reference to AtsCompany)"),
	questions: z.array().optional(),
	postings: z.array().optional().describe("Public job postings"),
	groups: z.array().optional().describe("The departments/divisions/teams that this job belongs to"),
	openings: z.array().optional(),
	minimum_experience_years: z.number().optional(),
	minimum_degree: z.string().optional(),
	skills: z.array().optional(),
	metadata: z.array().optional(),
	user_id: z.string().optional().describe("User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)"),
	industry: z.string().optional(),
	summary: z.string().optional().describe("Short job blurb (distinct from full description when both exist)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AtsJobStatus(str, Enum):
	ARCHIVED = 'ARCHIVED'
	PENDING = 'PENDING'
	DRAFT = 'DRAFT'
	OPEN = 'OPEN'
	CLOSED = 'CLOSED'

@dataclasses.dataclass
class AtsJobEmployment_type(str, Enum):
	FULL_TIME = 'FULL_TIME'
	PART_TIME = 'PART_TIME'
	CONTRACTOR = 'CONTRACTOR'
	INTERN = 'INTERN'
	CONSULTANT = 'CONSULTANT'
	VOLUNTEER = 'VOLUNTEER'
	CASUAL = 'CASUAL'
	SEASONAL = 'SEASONAL'
	FREELANCE = 'FREELANCE'
	OTHER = 'OTHER'

@dataclasses.dataclass
class AtsJob:
	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]
	"""The job's title"""
	name: Optional[str]
	description: Optional[str]
	recruiter_ids: Optional[List[List[str]]]
	hiring_manager_ids: Optional[List[List[str]]]
	hiring_managers: Optional[PropertyAtsJobHiring_managers]
	status: Optional[AtsJobStatus]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	closed_at: Optional[str]
	addresses: Optional[PropertyAtsJobAddresses]
	compensation: Optional[PropertyAtsJobCompensation]
	employment_type: Optional[AtsJobEmployment_type]
	remote: Optional[bool]
	"""Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)"""
	language_locale: Optional[str]
	"""URLs for pages containing public listings for the job"""
	public_job_urls: Optional[List[List[str]]]
	"""Number of openings for the job"""
	number_of_openings: Optional[int]
	"""id value of the company associated with the job in the ATS (reference to AtsCompany)"""
	company_id: Optional[str]
	questions: Optional[PropertyAtsJobQuestions]
	"""Public job postings"""
	postings: Optional[PropertyAtsJobPostings]
	"""The departments/divisions/teams that this job belongs to"""
	groups: Optional[PropertyAtsJobGroups]
	openings: Optional[PropertyAtsJobOpenings]
	minimum_experience_years: Optional[int]
	minimum_degree: Optional[str]
	skills: Optional[List[List[str]]]
	metadata: Optional[PropertyAtsJobMetadata]
	"""User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)"""
	user_id: Optional[str]
	industry: Optional[str]
	"""Short job blurb (distinct from full description when both exist)"""
	summary: Optional[str]
Are we missing anything? Let us know
Was this page helpful?