Scorecard data model

Updated:

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

Data Model
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)
application_idstringNo
interviewer_idstringNo
interview_idstringNo
candidate_idstringNo
job_idstringNo
recommendationenumNoValues: DEFINITELY_NO, NO, YES, STRONG_YES
commentstringNo
questionsAtsScorecardQuestion[]No
questions[].textstringYesThe question to ask the interviewer
questions[].descriptionstringNo
questions[].answerstringNoCandidate’s answer to the question
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 AtsScorecard = {
	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)
	application_id?: string;
	interviewer_id?: string;
	interview_id?: string;
	candidate_id?: string;
	job_id?: string;
	recommendation?: 'DEFINITELY_NO' | 'NO' | 'YES' | 'STRONG_YES';
	comment?: string;
	questions?: [];
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodAtsScorecard = 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)"),
	application_id: z.string().optional(),
	interviewer_id: z.string().optional(),
	interview_id: z.string().optional(),
	candidate_id: z.string().optional(),
	job_id: z.string().optional(),
	recommendation: z.enum("DEFINITELY_NO", "NO", "YES", "STRONG_YES").optional(),
	comment: z.string().optional(),
	questions: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AtsScorecardRecommendation(str, Enum):
	DEFINITELY_NO = 'DEFINITELY_NO'
	NO = 'NO'
	YES = 'YES'
	STRONG_YES = 'STRONG_YES'

@dataclasses.dataclass
class AtsScorecard:
	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]
	application_id: Optional[str]
	interviewer_id: Optional[str]
	interview_id: Optional[str]
	candidate_id: Optional[str]
	job_id: Optional[str]
	recommendation: Optional[AtsScorecardRecommendation]
	comment: Optional[str]
	questions: Optional[PropertyAtsScorecardQuestions]
	metadata: Optional[PropertyAtsScorecardMetadata]
Are we missing anything? Let us know
Was this page helpful?