Person data model

A person object from an enrichment integration

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

FieldTypeRequiredDescription
idstringNoUnique identifier for this person object
created_atstring (date-time)NoThe date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the person
first_namestringNo
last_namestringNo
titlestringNoThe job title of the person
birthdatestringNoThe birth date of the person
image_urlstringNoThe image URL of the person
biostringNoThe biography description of the person
companystringNoThe companyorganization name of the person
company_domainstringNoThe company's domain
emailsEnrichEmail[]NoAn array of email addresses for this person
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
emails[].is_verifiedbooleanNo
telephonesEnrichTelephone[]NoAn array of telephones for this person
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
twitter_handlestringNoThe twitter handle of the person
linkedin_urlstringNoThe LinkedIn URL of the person
github_urlstringNoThe GitHub URL of the person
github_usernamestringNoThe GitHub username of the person
twitter_urlstringNoThe twitter URL of the person
facebook_urlstringNoThe Facebook URL of the person
genderenumNoThe gender of the person Values: MALE, FEMALE
addressobjectNoThe address of the person
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNo
timezonestringNoThe timezone code of the person
utc_offsetnumberNoThe timezone's hourly offset from UTC of the person
work_historiesEnrichPersonWorkHistory[]No
work_histories[].company_idstringNo(reference to EnrichCompany)
work_histories[].company_namestringNo
work_histories[].titlestringYes
work_histories[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
work_histories[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
work_histories[].locationstringNo
work_histories[].company_domainstringNo

TypeScript

TypeScript
export type EnrichPerson = {
	id?: string; // Unique identifier for this person object
	created_at?: string-time; // The date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the person
	first_name?: string;
	last_name?: string;
	title?: string; // The job title of the person
	birthdate?: string; // The birth date of the person
	image_url?: string; // The image URL of the person
	bio?: string; // The biography description of the person
	company?: string; // The companyorganization name  of the person
	company_domain?: string; // The company's domain
	emails?: []; // An array of email addresses for this person
	telephones?: []; // An array of telephones for this person
	twitter_handle?: string; // The twitter handle of the person
	linkedin_url?: string; // The LinkedIn URL of the person
	github_url?: string; // The GitHub URL of the person
	github_username?: string; // The GitHub username of the person
	twitter_url?: string; // The twitter URL of the person
	facebook_url?: string; // The Facebook URL of the person
	gender?: 'MALE' | 'FEMALE'; // The gender of the person
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; 
	}; // The address of the person
	timezone?: string; // The timezone code of the person
	utc_offset?: number; // The timezone's hourly offset from UTC of the person
	work_histories?: [];
	raw?: any; // The raw data returned by the integration for this person
} 

Zod

Zod
import { z } from 'zod';

export const ZodEnrichPerson = z.object({
	id: z.string().optional().describe("Unique identifier for this person object"),
	created_at: z.string-time().optional().describe("The date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the person"),
	first_name: z.string().optional(),
	last_name: z.string().optional(),
	title: z.string().optional().describe("The job title of the person"),
	birthdate: z.string().optional().describe("The birth date of the person"),
	image_url: z.string().optional().describe("The image URL of the person"),
	bio: z.string().optional().describe("The biography description of the person"),
	company: z.string().optional().describe("The companyorganization name  of the person"),
	company_domain: z.string().optional().describe("The company's domain"),
	emails: z.array().optional().describe("An array of email addresses for this person"),
	telephones: z.array().optional().describe("An array of telephones for this person"),
	twitter_handle: z.string().optional().describe("The twitter handle of the person"),
	linkedin_url: z.string().optional().describe("The LinkedIn URL of the person"),
	github_url: z.string().optional().describe("The GitHub URL of the person"),
	github_username: z.string().optional().describe("The GitHub username of the person"),
	twitter_url: z.string().optional().describe("The twitter URL of the person"),
	facebook_url: z.string().optional().describe("The Facebook URL of the person"),
	gender: z.enum("MALE", "FEMALE").optional().describe("The gender of the person"),
	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()
}).optional().describe("The address of the person"),
	timezone: z.string().optional().describe("The timezone code of the person"),
	utc_offset: z.number().optional().describe("The timezone's hourly offset from UTC of the person"),
	work_histories: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class EnrichPersonGender(str, Enum):
	MALE = 'MALE'
	FEMALE = 'FEMALE'

@dataclasses.dataclass
class PropertyEnrichPersonAddress:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	country_code: Optional[str]

@dataclasses.dataclass
class EnrichPerson:
	"""Unique identifier for this person object"""
	id: Optional[str]
	"""The date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the person"""
	name: Optional[str]
	first_name: Optional[str]
	last_name: Optional[str]
	"""The job title of the person"""
	title: Optional[str]
	"""The birth date of the person"""
	birthdate: Optional[str]
	"""The image URL of the person"""
	image_url: Optional[str]
	"""The biography description of the person"""
	bio: Optional[str]
	"""The companyorganization name  of the person"""
	company: Optional[str]
	"""The company's domain"""
	company_domain: Optional[str]
	"""An array of email addresses for this person"""
	emails: Optional[PropertyEnrichPersonEmails]
	"""An array of telephones for this person"""
	telephones: Optional[PropertyEnrichPersonTelephones]
	"""The twitter handle of the person"""
	twitter_handle: Optional[str]
	"""The LinkedIn URL of the person"""
	linkedin_url: Optional[str]
	"""The GitHub URL of the person"""
	github_url: Optional[str]
	"""The GitHub username of the person"""
	github_username: Optional[str]
	"""The twitter URL of the person"""
	twitter_url: Optional[str]
	"""The Facebook URL of the person"""
	facebook_url: Optional[str]
	"""The gender of the person"""
	gender: Optional[EnrichPersonGender]
	"""The address of the person"""
	address: Optional[PropertyEnrichPersonAddress]
	"""The timezone code of the person"""
	timezone: Optional[str]
	"""The timezone's hourly offset from UTC of the person"""
	utc_offset: Optional[int]
	work_histories: Optional[PropertyEnrichPersonWork_histories]
Are we missing anything? Let us know
Was this page helpful?