Collection data model

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

Data Model
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
mediaLmsMedia[]No
media[].urlstringNo
media[].namestringNo
media[].descriptionstringNo
media[].typeenumNoValues: IMAGE, HEADSHOT, VIDEO, WEB, DOCUMENT, TEXT, HTML, OTHER
media[].thumbnail_urlstringNo
media[].contentstringNoInline text/HTML/markdown content (use when url is empty or for embedded content)
media[].languagesstring[]NoISO 2-digit language codes
is_activebooleanNo
parent_idstringNo

TypeScript

TypeScript
export type LmsCollection = {
	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;
	media?: [];
	is_active?: boolean;
	parent_id?: string;
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodLmsCollection = 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(),
	media: z.array().optional(),
	is_active: z.boolean().optional(),
	parent_id: z.string().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class LmsCollection:
	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]
	media: Optional[PropertyLmsCollectionMedia]
	is_active: Optional[bool]
	parent_id: Optional[str]
Are we missing anything? Let us know
Was this page helpful?