Company data model

A company 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 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
descriptionstringNoThe description of the company
domainstringNoThe webmail domain of the company
twitter_handlestringNoThe twitter handle of the company
twitter_urlstringNoThe twitter URL of the company
addressobjectNoThe address of the company
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNo
telephonesEnrichTelephone[]NoAn array of telephones for this company
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
linkedin_urlstringNoThe LinkedIn URL of the company
crunchbase_urlstringNoThe Crunchbase URL of the company
facebook_urlstringNoThe Facebook URL of the company
youtube_urlstringNoThe Youtube URL of the company
instagram_urlstringNoThe Crunchbase URL of the company
yelp_urlstringNoThe Yelp URL of the company
logo_urlstringNoThe URL of the logo of the company
exchangestringNoThe public exchange of the company (eg. NASDAQ)
stockstringNoThe stock ticker of the company (eg. AMZN)
year_foundednumberNoThe year that the company was founded
alexa_ranknumberNoThe Alexa rank of the company
naics_codenumberNoThe NAICS code of the company
sic_codenumberNoThe SIC code of the company
employeesstringNoThe number of employees at the company
revenuestringNoThe approximate revenue of the company
industrystringNoThe industry of the company

TypeScript

TypeScript
export type EnrichCompany = {
	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
	description?: string; // The description of the company
	domain?: string; // The webmail domain of the company
	twitter_handle?: string; // The twitter handle of the company
	twitter_url?: string; // The twitter URL of the company
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; 
	}; // The address of the company
	telephones?: []; // An array of telephones for this company
	linkedin_url?: string; // The LinkedIn URL of the company
	crunchbase_url?: string; // The Crunchbase URL of the company
	facebook_url?: string; // The Facebook URL of the company
	youtube_url?: string; // The Youtube URL of the company
	instagram_url?: string; // The Crunchbase URL of the company
	yelp_url?: string; // The Yelp URL of the company
	logo_url?: string; // The URL of the logo of the company
	exchange?: string; // The public exchange of the company (eg. NASDAQ)
	stock?: string; // The stock ticker of the company (eg. AMZN)
	year_founded?: number; // The year that the company was founded
	alexa_rank?: number; // The Alexa rank of the company
	naics_code?: number; // The NAICS code of the company
	sic_code?: number; // The SIC code of the company
	employees?: string; // The number of employees at the company
	revenue?: string; // The approximate revenue of the company
	industry?: string; // The industry of the company
	raw?: any; // The raw data returned by the integration for this company
} 

Zod

Zod
import { z } from 'zod';

export const ZodEnrichCompany = 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"),
	description: z.string().optional().describe("The description of the company"),
	domain: z.string().optional().describe("The webmail domain of the company"),
	twitter_handle: z.string().optional().describe("The twitter handle of the company"),
	twitter_url: z.string().optional().describe("The twitter URL of the company"),
	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 company"),
	telephones: z.array().optional().describe("An array of telephones for this company"),
	linkedin_url: z.string().optional().describe("The LinkedIn URL of the company"),
	crunchbase_url: z.string().optional().describe("The Crunchbase URL of the company"),
	facebook_url: z.string().optional().describe("The Facebook URL of the company"),
	youtube_url: z.string().optional().describe("The Youtube URL of the company"),
	instagram_url: z.string().optional().describe("The Crunchbase URL of the company"),
	yelp_url: z.string().optional().describe("The Yelp URL of the company"),
	logo_url: z.string().optional().describe("The URL of the logo of the company"),
	exchange: z.string().optional().describe("The public exchange of the company (eg. NASDAQ)"),
	stock: z.string().optional().describe("The stock ticker of the company (eg. AMZN)"),
	year_founded: z.number().optional().describe("The year that the company was founded"),
	alexa_rank: z.number().optional().describe("The Alexa rank of the company"),
	naics_code: z.number().optional().describe("The NAICS code of the company"),
	sic_code: z.number().optional().describe("The SIC code of the company"),
	employees: z.string().optional().describe("The number of employees at the company"),
	revenue: z.string().optional().describe("The approximate revenue of the company"),
	industry: z.string().optional().describe("The industry of the company"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyEnrichCompanyAddress:
	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 EnrichCompany:
	"""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]
	"""The description of the company"""
	description: Optional[str]
	"""The webmail domain of the company"""
	domain: Optional[str]
	"""The twitter handle of the company"""
	twitter_handle: Optional[str]
	"""The twitter URL of the company"""
	twitter_url: Optional[str]
	"""The address of the company"""
	address: Optional[PropertyEnrichCompanyAddress]
	"""An array of telephones for this company"""
	telephones: Optional[PropertyEnrichCompanyTelephones]
	"""The LinkedIn URL of the company"""
	linkedin_url: Optional[str]
	"""The Crunchbase URL of the company"""
	crunchbase_url: Optional[str]
	"""The Facebook URL of the company"""
	facebook_url: Optional[str]
	"""The Youtube URL of the company"""
	youtube_url: Optional[str]
	"""The Crunchbase URL of the company"""
	instagram_url: Optional[str]
	"""The Yelp URL of the company"""
	yelp_url: Optional[str]
	"""The URL of the logo of the company"""
	logo_url: Optional[str]
	"""The public exchange of the company (eg. NASDAQ)"""
	exchange: Optional[str]
	"""The stock ticker of the company (eg. AMZN)"""
	stock: Optional[str]
	"""The year that the company was founded"""
	year_founded: Optional[int]
	"""The Alexa rank of the company"""
	alexa_rank: Optional[int]
	"""The NAICS code of the company"""
	naics_code: Optional[int]
	"""The SIC code of the company"""
	sic_code: Optional[int]
	"""The number of employees at the company"""
	employees: Optional[str]
	"""The approximate revenue of the company"""
	revenue: Optional[str]
	"""The industry of the company"""
	industry: Optional[str]
Are we missing anything? Let us know
Was this page helpful?