Company data model

A company represents an organization that optionally is associated with a deal and/or contacts

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

FieldTypeRequiredDescription
idstringNoUnique identifier for this company object
created_atstring (date-time)NoThe date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the company
deal_idsstring[]NoAn array of deal IDs associated with this contact
contact_idsstring[]NoAn array of contact IDs associated with this company
emailsCrmEmail[]No
emails[].emailstringNo
emails[].typeenumNoValues: WORK, HOME, OTHER
telephonesCrmTelephone[]No
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
websitesstring[]No
addressobjectNo
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNoISO 2-digit country code
is_activebooleanNo
tagsstring[]No
descriptionstringNo
industrystringNo
link_urlsstring[]NoAdditional URLs associated with the contact e.g., LinkedIn, website, etc
employeesnumberNo
timezonestringNo
user_idstringNo(reference to HrisEmployee)
metadataCrmMetadata[]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
domainsstring[]No

TypeScript

TypeScript
export type CrmCompany = {
	id?: string; // Unique identifier for this company object
	created_at?: string-time; // The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the company
	deal_ids?: string[]; // An array of deal IDs associated with this contact
	contact_ids?: string[]; // An array of contact IDs associated with this company
	emails?: [];
	telephones?: [];
	websites?: string[];
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // ISO 2-digit country code 
	};
	is_active?: boolean;
	tags?: string[];
	description?: string;
	industry?: string;
	link_urls?: string[]; // Additional URLs associated with the contact e.g., LinkedIn, website, etc
	employees?: number;
	timezone?: string;
	user_id?: string; // (reference to HrisEmployee)
	metadata?: [];
	domains?: string[];
	raw?: any; // The raw data returned by the integration for this company
} 

Zod

Zod
import { z } from 'zod';

export const ZodCrmCompany = z.object({
	id: z.string().optional().describe("Unique identifier for this company object"),
	created_at: z.string-time().optional().describe("The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the company"),
	deal_ids: z.array().optional().describe("An array of deal IDs associated with this contact"),
	contact_ids: z.array().optional().describe("An array of contact IDs associated with this company"),
	emails: z.array().optional(),
	telephones: z.array().optional(),
	websites: z.array().optional(),
	address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			region_code: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("ISO 2-digit country code")
}).optional(),
	is_active: z.boolean().optional(),
	tags: z.array().optional(),
	description: z.string().optional(),
	industry: z.string().optional(),
	link_urls: z.array().optional().describe("Additional URLs associated with the contact e.g., LinkedIn, website, etc"),
	employees: z.number().optional(),
	timezone: z.string().optional(),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	metadata: z.array().optional(),
	domains: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyCrmCompanyAddress:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""ISO 2-digit country code"""
	country_code: Optional[str]

@dataclasses.dataclass
class CrmCompany:
	"""Unique identifier for this company object"""
	id: Optional[str]
	"""The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the company"""
	name: Optional[str]
	"""An array of deal IDs associated with this contact"""
	deal_ids: Optional[List[List[str]]]
	"""An array of contact IDs associated with this company"""
	contact_ids: Optional[List[List[str]]]
	emails: Optional[PropertyCrmCompanyEmails]
	telephones: Optional[PropertyCrmCompanyTelephones]
	websites: Optional[List[List[str]]]
	address: Optional[PropertyCrmCompanyAddress]
	is_active: Optional[bool]
	tags: Optional[List[List[str]]]
	description: Optional[str]
	industry: Optional[str]
	"""Additional URLs associated with the contact e.g., LinkedIn, website, etc"""
	link_urls: Optional[List[List[str]]]
	employees: Optional[int]
	timezone: Optional[str]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	metadata: Optional[PropertyCrmCompanyMetadata]
	domains: Optional[List[List[str]]]
Are we missing anything? Let us know
Was this page helpful?