Table data model

Updated:

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
database_idstringNosource Database ID
fieldsDatastoreField[]No
fields[].idstringNo
fields[].namestringYes
fields[].typeenumYesValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, CURRENCY, URL, EMAIL, PHONE, LINKED_RECORD, RELATION
fields[].original_typestringYes
fields[].is_requiredbooleanNo
fields[].is_indexedbooleanNo
fields[].is_primary_keybooleanNo
fields[].is_uniquebooleanNo
fields[].is_nullablebooleanNo
fields[].max_lengthnumberNo
fields[].precisionnumberNo
fields[].scalenumberNo
fields[].default_valueDatastoreField_default_valueNo
fields[].default_value.stringstringNo
fields[].default_value.numbernumberNo
fields[].default_value.booleanbooleanNo
fields[].default_value.datestringNo
fields[].default_value.selectionstring[]No
fields[].default_value.is_nullbooleanNo
fields[].descriptionstringNo
relationshipsDatastoreRelationship[]No
relationships[].namestringYes
relationships[].fieldstringYes
relationships[].table_idstringYestarget Database Table ID
relationships[].typeenumYesValues: ONE, MANY
web_urlstringNo
parent_idstringNo
metadataDatastoreMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
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.
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
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type DatastoreTable = {
	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;
	database_id?: string; // source Database ID
	fields?: [];
	relationships?: [];
	web_url?: string;
	parent_id?: string;
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodDatastoreTable = 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(),
	database_id: z.string().optional().describe("source Database ID"),
	fields: z.array().optional(),
	relationships: z.array().optional(),
	web_url: z.string().optional(),
	parent_id: z.string().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class DatastoreTable:
	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]
	"""source Database ID"""
	database_id: Optional[str]
	fields: Optional[PropertyDatastoreTableFields]
	relationships: Optional[PropertyDatastoreTableRelationships]
	web_url: Optional[str]
	parent_id: Optional[str]
	metadata: Optional[PropertyDatastoreTableMetadata]
Are we missing anything? Let us know
Was this page helpful?