Goal 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)
namestringNo
descriptionstringNo
user_idsstring[]NoHR Employees that own or share this goal; the first element is the primary owner
company_idstringNo
parent_idstringNoid of the parent goal, for goal alignment / OKR trees
cycle_idstringNopointer to the Performance Cycle object (goal cycle or timeframe)
typeenumNoValues: INDIVIDUAL, TEAM, DEPARTMENT, COMPANY, OTHER
statusenumNoValues: NOT_STARTED, IN_PROGRESS, COMPLETED, CLOSED, OTHER
progressnumberNoprogress percentage from 0 to 100
weightnumberNothe weight of this goal when the provider weighs goals in reviews
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
milestonesPerformanceGoalMilestone[]Nomilestones or key results for this goal
milestones[].idstringNo
milestones[].namestringYes
milestones[].descriptionstringNo
milestones[].target_valuenumberNo
milestones[].current_valuenumberNo
milestones[].unitstringNounit of the target/current values (e.g. %, USD, count)
milestones[].weightnumberNo
milestones[].is_completedbooleanNo
milestones[].due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataPerformanceMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type PerformanceGoal = {
	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;
	description?: string;
	user_ids?: string[]; // HR Employees that own or share this goal; the first element is the primary owner
	company_id?: string;
	parent_id?: string; // id of the parent goal, for goal alignment / OKR trees
	cycle_id?: string; // pointer to the Performance Cycle object (goal cycle or timeframe)
	type?: 'INDIVIDUAL' | 'TEAM' | 'DEPARTMENT' | 'COMPANY' | 'OTHER';
	status?: 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'CLOSED' | 'OTHER';
	progress?: number; // progress percentage from 0 to 100
	weight?: number; // the weight of this goal when the provider weighs goals in reviews
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	due_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	completed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	milestones?: []; // milestones or key results for this goal
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodPerformanceGoal = 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(),
	description: z.string().optional(),
	user_ids: z.array().optional().describe("HR Employees that own or share this goal; the first element is the primary owner"),
	company_id: z.string().optional(),
	parent_id: z.string().optional().describe("id of the parent goal, for goal alignment / OKR trees"),
	cycle_id: z.string().optional().describe("pointer to the Performance Cycle object (goal cycle or timeframe)"),
	type: z.enum("INDIVIDUAL", "TEAM", "DEPARTMENT", "COMPANY", "OTHER").optional(),
	status: z.enum("NOT_STARTED", "IN_PROGRESS", "COMPLETED", "CLOSED", "OTHER").optional(),
	progress: z.number().optional().describe("progress percentage from 0 to 100"),
	weight: z.number().optional().describe("the weight of this goal when the provider weighs goals in reviews"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	due_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	completed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	milestones: z.array().optional().describe("milestones or key results for this goal"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PerformanceGoalType(str, Enum):
	INDIVIDUAL = 'INDIVIDUAL'
	TEAM = 'TEAM'
	DEPARTMENT = 'DEPARTMENT'
	COMPANY = 'COMPANY'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceGoalStatus(str, Enum):
	NOT_STARTED = 'NOT_STARTED'
	IN_PROGRESS = 'IN_PROGRESS'
	COMPLETED = 'COMPLETED'
	CLOSED = 'CLOSED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceGoal:
	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]
	name: Optional[str]
	description: Optional[str]
	"""HR Employees that own or share this goal; the first element is the primary owner"""
	user_ids: Optional[List[List[str]]]
	company_id: Optional[str]
	"""id of the parent goal, for goal alignment / OKR trees"""
	parent_id: Optional[str]
	"""pointer to the Performance Cycle object (goal cycle or timeframe)"""
	cycle_id: Optional[str]
	type: Optional[PerformanceGoalType]
	status: Optional[PerformanceGoalStatus]
	"""progress percentage from 0 to 100"""
	progress: Optional[int]
	"""the weight of this goal when the provider weighs goals in reviews"""
	weight: Optional[int]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	due_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	completed_at: Optional[str]
	"""milestones or key results for this goal"""
	milestones: Optional[PropertyPerformanceGoalMilestones]
	metadata: Optional[PropertyPerformanceGoalMetadata]
Are we missing anything? Let us know
Was this page helpful?