The Deals API gives you read-only access to deals synced from your CRM integrations.
Deals are synced from integrations and cannot be created, updated, or deleted via the API.
Scopes
| Scope | Access |
|---|---|
CRM_READ | Get and search deals |
Associations
- Deal → Company: A deal can be associated with one company (
company_id) - Deal → Person: A deal can be linked to a person via integration sync
Search
Deals support search via POST /v2/api/crm/deals/search with full-text search and a stage filter.
Endpoints
Get deal
Get a deal by ID
Search deals
Search deals by keyword