Cycle 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
typeenumNowhether this is a review cycle or a goal cycle/timeframe Values: REVIEW, GOAL, OTHER
statusenumNoValues: DRAFT, SCHEDULED, ACTIVE, CLOSED, OTHER
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)
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 PerformanceCycle = {
	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;
	type?: 'REVIEW' | 'GOAL' | 'OTHER'; // whether this is a review cycle or a goal cycle/timeframe
	status?: 'DRAFT' | 'SCHEDULED' | 'ACTIVE' | 'CLOSED' | 'OTHER';
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	due_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodPerformanceCycle = 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(),
	type: z.enum("REVIEW", "GOAL", "OTHER").optional().describe("whether this is a review cycle or a goal cycle/timeframe"),
	status: z.enum("DRAFT", "SCHEDULED", "ACTIVE", "CLOSED", "OTHER").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)"),
	due_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PerformanceCycleType(str, Enum):
	REVIEW = 'REVIEW'
	GOAL = 'GOAL'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceCycleStatus(str, Enum):
	DRAFT = 'DRAFT'
	SCHEDULED = 'SCHEDULED'
	ACTIVE = 'ACTIVE'
	CLOSED = 'CLOSED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PerformanceCycle:
	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]
	"""whether this is a review cycle or a goal cycle/timeframe"""
	type: Optional[PerformanceCycleType]
	status: Optional[PerformanceCycleStatus]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	due_at: Optional[str]
	metadata: Optional[PropertyPerformanceCycleMetadata]
Are we missing anything? Let us know
Was this page helpful?