Taxonomy data model

Updated:

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

Data Model
FieldTypeRequiredDescription
idstringYes
namestringNo
labelstringNo
typeenumNoValues: INDUSTRY
metadataCrmMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name of an existing custom field (e.g. Region__c in Salesforce). 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 CrmTaxonomy = {
	id: string;
	name?: string;
	label?: string;
	type?: 'INDUSTRY';
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodCrmTaxonomy = z.object({
	id: z.string(),
	name: z.string().optional(),
	label: z.string().optional(),
	type: z.enum("INDUSTRY").optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CrmTaxonomyType(str, Enum):
	INDUSTRY = 'INDUSTRY'

@dataclasses.dataclass
class CrmTaxonomy:
	id: str
	name: Optional[str]
	label: Optional[str]
	type: Optional[CrmTaxonomyType]
	metadata: Optional[PropertyCrmTaxonomyMetadata]
Are we missing anything? Let us know
Was this page helpful?