AI agent? Read this page as Markdown at /crm/deal/model.md — append .md to any docs URL, or start from /llms.txt. Agent Skill for this page: /skills/unified-crm/SKILL.md.
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.
idstring
Unique identifier for this deal object
created_atdate-time
The date that this deal object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
The last date that this deal object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The name of this deal
amountnumber
The potential amount that deal could be worth
currencystring
The currency for the deal amount (3 letter ISO code; eg. USD)
closed_atdate-time
The date that this deal closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closing_atdate-time
expected closing date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sourcestring
The source for this deal
probabilitynumber
tagsstring array
lost_reasonstring
won_reasonstring
user_idstring
(reference to HrisEmployee)
contact_idsstring array
(reference to CrmContact)
company_idsstring array
(reference to CrmCompany)
descriptionstring
Are we missing anything? Let us know