Page 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)
titlestringNoThe page's title
typeenumYesValues: HTML, MARKDOWN, TEXT, OTHER
space_idstringNo(reference to KmsSpace)
parent_idstringNo
is_activebooleanNo
user_idstringNo(reference to HrisEmployee)
download_urlstringNo
metadataKmsPageMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
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, PERCENT, EMAIL, PHONE, REFERENCE, TIME
metadata[].extra_dataobjectNo
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.
has_childrenbooleanNo
web_urlstringNo
contentstringNoThe page body, in the format given by type. Used to create/update only; read a page's body from download_url.

TypeScript

TypeScript
export type KmsPage = {
	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)
	title?: string; // The page's title
	type: 'HTML' | 'MARKDOWN' | 'TEXT' | 'OTHER';
	space_id?: string; // (reference to KmsSpace)
	parent_id?: string;
	is_active?: boolean;
	user_id?: string; // (reference to HrisEmployee)
	download_url?: string;
	metadata?: [];
	has_children?: boolean;
	web_url?: string;
	raw?: any;
	content?: string; // The page body, in the format given by `type`. Used to create/update only; read a page's body from `download_url`.
} 

Zod

Zod
import { z } from 'zod';

export const ZodKmsPage = 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)"),
	title: z.string().optional().describe("The page's title"),
	type: z.enum("HTML", "MARKDOWN", "TEXT", "OTHER"),
	space_id: z.string().optional().describe("(reference to KmsSpace)"),
	parent_id: z.string().optional(),
	is_active: z.boolean().optional(),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	download_url: z.string().optional(),
	metadata: z.array().optional(),
	has_children: z.boolean().optional(),
	web_url: z.string().optional(),
,
	content: z.string().optional().describe("The page body, in the format given by `type`. Used to create/update only; read a page's body from `download_url`.")
});

Python

Python
import dataclasses

@dataclasses.dataclass
class KmsPageType(str, Enum):
	HTML = 'HTML'
	MARKDOWN = 'MARKDOWN'
	TEXT = 'TEXT'
	OTHER = 'OTHER'

@dataclasses.dataclass
class KmsPage:
	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]
	"""The page's title"""
	title: Optional[str]
	type: KmsPageType
	"""(reference to KmsSpace)"""
	space_id: Optional[str]
	parent_id: Optional[str]
	is_active: Optional[bool]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	download_url: Optional[str]
	metadata: Optional[PropertyKmsPageMetadata]
	has_children: Optional[bool]
	web_url: Optional[str]

	"""The page body, in the format given by `type`. Used to create/update only; read a page's body from `download_url`."""
	content: Optional[str]
Are we missing anything? Let us know
Was this page helpful?