Room data model

Updated:

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

FieldTypeRequiredDescription
idstringNo
namestringNo
capacitynumberNo
location_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)
descriptionstringNo
typeenumNoValues: ROOM, DESK, OTHER
emailstringNothe room's calendar/mailbox address, used to invite the room to an event
calendar_idstringNo(reference to CalendarCalendar)
floorstringNo
timezonestringNo
web_urlstringNo
is_activebooleanNo
is_bookablebooleanNo
featuresobjectNoe.g. projector, whiteboard, video conferencing
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 CalendarRoom = {
	id?: string;
	name?: string;
	capacity?: number;
	location_id?: string;
	raw?: any;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	description?: string;
	type?: 'ROOM' | 'DESK' | 'OTHER';
	email?: string; // the room's calendar/mailbox address, used to invite the room to an event
	calendar_id?: string; // (reference to CalendarCalendar)
	floor?: string;
	timezone?: string;
	web_url?: string;
	is_active?: boolean;
	is_bookable?: boolean;
	features?: any; // e.g. projector, whiteboard, video conferencing
	metadata?: [];
} 

Zod

Zod
import { z } from 'zod';

export const ZodCalendarRoom = z.object({
	id: z.string().optional(),
	name: z.string().optional(),
	capacity: z.number().optional(),
	location_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)"),
	description: z.string().optional(),
	type: z.enum("ROOM", "DESK", "OTHER").optional(),
	email: z.string().optional().describe("the room's calendar/mailbox address, used to invite the room to an event"),
	calendar_id: z.string().optional().describe("(reference to CalendarCalendar)"),
	floor: z.string().optional(),
	timezone: z.string().optional(),
	web_url: z.string().optional(),
	is_active: z.boolean().optional(),
	is_bookable: z.boolean().optional(),
	features: z.unknown().optional().describe("e.g. projector, whiteboard, video conferencing"),
	metadata: z.array().optional()
});

Python

Python
import dataclasses

@dataclasses.dataclass
class CalendarRoomType(str, Enum):
	ROOM = 'ROOM'
	DESK = 'DESK'
	OTHER = 'OTHER'

@dataclasses.dataclass
class CalendarRoom:
	id: Optional[str]
	name: Optional[str]
	capacity: Optional[int]
	location_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]
	description: Optional[str]
	type: Optional[CalendarRoomType]
	"""the room's calendar/mailbox address, used to invite the room to an event"""
	email: Optional[str]
	"""(reference to CalendarCalendar)"""
	calendar_id: Optional[str]
	floor: Optional[str]
	timezone: Optional[str]
	web_url: Optional[str]
	is_active: Optional[bool]
	is_bookable: Optional[bool]
	"""e.g. projector, whiteboard, video conferencing"""
	features: Optional[PropertyCalendarRoomFeatures]
	metadata: Optional[PropertyCalendarRoomMetadata]
Are we missing anything? Let us know
Was this page helpful?