Contact data model

A contact represents a person that optionally is associated with a deal and/or a company

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

FieldTypeRequiredDescription
idstringNoUnique identifier for this contact object
created_atstring (date-time)NoThe date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the contact
first_namestringNo
last_namestringNo
titlestringNoThe job title of the contact
companystringNoThe companyorganization name of the contact
emailsCrmEmail[]NoAn array of email addresses for this contact
emails[].emailstringNo
emails[].typeenumNoValues: WORK, HOME, OTHER
telephonesCrmTelephone[]NoAn array of telephones for this contact
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
deal_idsstring[]NoAn array of deal IDs associated with this contact
company_idsstring[]NoAn array of company IDs associated with this contact
addressobjectNo
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNoISO 2-digit country code
user_idstringNo(reference to HrisEmployee)
link_urlsstring[]NoAdditional URLs associated with the contact e.g., LinkedIn, website, etc
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
departmentstringNo
image_urlstringNo

TypeScript

TypeScript
export type CrmContact = {
	id?: string; // Unique identifier for this contact object
	created_at?: string-time; // The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the contact
	first_name?: string;
	last_name?: string;
	title?: string; // The job title of the contact
	company?: string; // The companyorganization name  of the contact
	emails?: []; // An array of email addresses for this contact
	telephones?: []; // An array of telephones for this contact
	deal_ids?: string[]; // An array of deal IDs associated with this contact
	company_ids?: string[]; // An array of company IDs associated with this contact
	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 
	};
	user_id?: string; // (reference to HrisEmployee)
	link_urls?: string[]; // Additional URLs associated with the contact e.g., LinkedIn, website, etc
	metadata?: [];
	department?: string;
	image_url?: string;
	raw?: any; // The raw data returned by the integration for this contact
} 

Zod

Zod
import { z } from 'zod';

export const ZodCrmContact = z.object({
	id: z.string().optional().describe("Unique identifier for this contact object"),
	created_at: z.string-time().optional().describe("The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the contact"),
	first_name: z.string().optional(),
	last_name: z.string().optional(),
	title: z.string().optional().describe("The job title of the contact"),
	company: z.string().optional().describe("The companyorganization name  of the contact"),
	emails: z.array().optional().describe("An array of email addresses for this contact"),
	telephones: z.array().optional().describe("An array of telephones for this contact"),
	deal_ids: z.array().optional().describe("An array of deal IDs associated with this contact"),
	company_ids: z.array().optional().describe("An array of company IDs associated with this contact"),
	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(),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	link_urls: z.array().optional().describe("Additional URLs associated with the contact e.g., LinkedIn, website, etc"),
	metadata: z.array().optional(),
	department: z.string().optional(),
	image_url: z.string().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyCrmContactAddress:
	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 CrmContact:
	"""Unique identifier for this contact object"""
	id: Optional[str]
	"""The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the contact"""
	name: Optional[str]
	first_name: Optional[str]
	last_name: Optional[str]
	"""The job title of the contact"""
	title: Optional[str]
	"""The companyorganization name  of the contact"""
	company: Optional[str]
	"""An array of email addresses for this contact"""
	emails: Optional[PropertyCrmContactEmails]
	"""An array of telephones for this contact"""
	telephones: Optional[PropertyCrmContactTelephones]
	"""An array of deal IDs associated with this contact"""
	deal_ids: Optional[List[List[str]]]
	"""An array of company IDs associated with this contact"""
	company_ids: Optional[List[List[str]]]
	address: Optional[PropertyCrmContactAddress]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	"""Additional URLs associated with the contact e.g., LinkedIn, website, etc"""
	link_urls: Optional[List[List[str]]]
	metadata: Optional[PropertyCrmContactMetadata]
	department: Optional[str]
	image_url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?