--- title: "Company data model" url: "https://docs.unified.to/crm/company/model" description: "The Company data model object in Unified's Company API: 20 fields, including created_at, updated_at and name, with types and enum values." --- # 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](https://docs.unified.to/crm/integrations.md) page. | Field | Type | Required | Description | | ------------------------ | ----------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for this company object | | created\_at | string (date-time) | No | The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | The name of the company | | deal\_ids | string\[\] | No | An array of deal IDs associated with this contact | | contact\_ids | string\[\] | No | An array of contact IDs associated with this company | | emails | [CrmEmail](https://docs.unified.to/crm/company/model.md#CrmEmail)\[\] | No | | | emails\[\].email | string | No | | | emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | telephones | [CrmTelephone](https://docs.unified.to/crm/company/model.md#CrmTelephone)\[\] | No | | | telephones\[\].telephone | string | Yes | | | telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | websites | string\[\] | No | | | address | object | No | | | address.address1 | string | No | | | address.address2 | string | No | | | address.city | string | No | | | address.region | string | No | | | address.region\_code | string | No | | | address.postal\_code | string | No | | | address.country | string | No | | | address.country\_code | string | No | ISO 2-digit country code | | is\_active | boolean | No | | | tags | string\[\] | No | | | description | string | No | | | industry | string | No | | | link\_urls | string\[\] | No | Additional URLs associated with the contact e.g., LinkedIn, website, etc | | employees | number | No | | | timezone | string | No | | | user\_id | string | No | (reference to HrisEmployee) | | metadata | [CrmMetadata](https://docs.unified.to/crm/company/model.md#CrmMetadata)\[\] | No | | | metadata\[\].id | string | No | | | metadata\[\].slug | string | No | | | metadata\[\].value | object | No | | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | metadata\[\].extra\_data | object | No | | | domains | string\[\] | 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 ```typescript 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]]] ```