Deal data model
A deal represents an opportunity with companies 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 deal object |
created_at | string (date-time) | No | The date that this deal object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this deal object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The name of this deal |
amount | number | No | The potential amount that deal could be worth |
currency | string | No | The currency for the deal amount (3 letter ISO code; eg. USD) |
closed_at | string (date-time) | No | The date that this deal closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
closing_at | string (date-time) | No | expected closing date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
stages | CrmReference[] | No | |
stages[].id | string | No | |
stages[].name | string | No | |
stages[].type | string | No | |
pipelines | CrmReference[] | No | |
pipelines[].id | string | No | |
pipelines[].name | string | No | |
pipelines[].type | string | No | |
source | string | No | The source for this deal |
probability | number | No | |
tags | string[] | No | |
lost_reason | string | No | |
won_reason | string | No | |
user_id | string | No | (reference to HrisEmployee) |
contact_ids | string[] | No | (reference to CrmContact) |
company_ids | string[] | No | (reference to CrmCompany) |
description | string | No | |
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 |
Are we missing anything? Let us know