ChatGPT ↗
Claude ↗This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
Results are scoped to the authenticated organization, ordered by most recently updated first. count is the number of Deals on this page, not the total matching count. Continue with skip and limit.
Query parameters
company_id· optionalstring
Only Deals linked to this company.
lead_id· optionalstring
Only Deals linked to this lead.
owner_user_id· optionalstring
Filter by owner user ID.
pipeline_id· optionalstring
Filter by pipeline ID.
stage_id· optionalstring
Filter by stage ID.
state· optionalstring
open, won, lost, or unknown.
q· optionalstring
Literal, case-insensitive name search; at most 200 characters.
include_archived· optionalboolean
Include archived Deals; default false.
limit· optionalinteger
Page size 1–200; default 100.
skip· optionalinteger
Number of matching Deals to skip; default 0.
| Name | Type | Description |
|---|---|---|
| company_id | string | Only Deals linked to this company. |
| lead_id | string | Only Deals linked to this lead. |
| owner_user_id | string | Filter by owner user ID. |
| pipeline_id | string | Filter by pipeline ID. |
| stage_id | string | Filter by stage ID. |
| state | string | open, won, lost, or unknown. |
| q | string | Literal, case-insensitive name search; at most 200 characters. |
| include_archived | boolean | Include archived Deals; default false. |
| limit | integer | Page size 1–200; default 100. |
| skip | integer | Number of matching Deals to skip; default 0. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication required. |
| 403 | Missing deals:read scope. |
| 422 | Invalid filter or pagination value. |