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.
| 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[] | No | |
emails[].email | string | No | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
telephones | 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[] | 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 |
Are we missing anything? Let us know