Busy data model

Updated:

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

Data Model
FieldTypeRequiredDescription
idstringNo
start_atstring (date-time)Yes(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)Yes(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
timezonestringNo
descriptionstringNo
metadataCalendarMetadata[]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 CalendarBusy = {
	id?: string;
	start_at: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	timezone?: string;
	description?: string;
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodCalendarBusy = z.object({
	id: z.string().optional(),
	start_at: z.string-time().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	timezone: z.string().optional(),
	description: z.string().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CalendarBusy:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: str
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: str
	timezone: Optional[str]
	description: Optional[str]
	metadata: Optional[PropertyCalendarBusyMetadata]
Are we missing anything? Let us know
Was this page helpful?