Interview 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)
candidate_idstringNo
job_idstringNo
application_idstringNo
user_idsstring[]No(reference to HrisEmployee)
statusenumNoValues: SCHEDULED, AWAITING_FEEDBACK, COMPLETE, CANCELED, NEEDS_SCHEDULING
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
locationstringNo
meeting_urlstringNothe URL of the virtual/video meeting (eg. Zoom, Google Meet, Microsoft Teams)
external_event_xrefstringNothe ID of the event in a calendar
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

TypeScript

TypeScript
export type AtsInterview = {
	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)
	candidate_id?: string;
	job_id?: string;
	application_id?: string;
	user_ids?: string[]; // (reference to HrisEmployee)
	status?: 'SCHEDULED' | 'AWAITING_FEEDBACK' | 'COMPLETE' | 'CANCELED' | 'NEEDS_SCHEDULING';
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	location?: string;
	meeting_url?: string; // the URL of the virtual/video meeting (eg. Zoom, Google Meet, Microsoft Teams)
	external_event_xref?: string; // the ID of the event in a calendar
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAtsInterview = 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)"),
	candidate_id: z.string().optional(),
	job_id: z.string().optional(),
	application_id: z.string().optional(),
	user_ids: z.array().optional().describe("(reference to HrisEmployee)"),
	status: z.enum("SCHEDULED", "AWAITING_FEEDBACK", "COMPLETE", "CANCELED", "NEEDS_SCHEDULING").optional(),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	location: z.string().optional(),
	meeting_url: z.string().optional().describe("the URL of the virtual/video meeting (eg. Zoom, Google Meet, Microsoft Teams)"),
	external_event_xref: z.string().optional().describe("the ID of the event in a calendar"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AtsInterviewStatus(str, Enum):
	SCHEDULED = 'SCHEDULED'
	AWAITING_FEEDBACK = 'AWAITING_FEEDBACK'
	COMPLETE = 'COMPLETE'
	CANCELED = 'CANCELED'
	NEEDS_SCHEDULING = 'NEEDS_SCHEDULING'

@dataclasses.dataclass
class AtsInterview:
	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]
	candidate_id: Optional[str]
	job_id: Optional[str]
	application_id: Optional[str]
	"""(reference to HrisEmployee)"""
	user_ids: Optional[List[List[str]]]
	status: Optional[AtsInterviewStatus]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	location: Optional[str]
	"""the URL of the virtual/video meeting (eg. Zoom, Google Meet, Microsoft Teams)"""
	meeting_url: Optional[str]
	"""the ID of the event in a calendar"""
	external_event_xref: Optional[str]
	metadata: Optional[PropertyAtsInterviewMetadata]
Are we missing anything? Let us know
Was this page helpful?