listDeals
Retrieve and filter deals by status, stage, pipeline, user, or person. Supports pagination and customization of returned fields.
Instructions
List deals with filtering
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Comma-separated deal IDs | |
| next | No | Cursor for next page of results | |
| sort | No | Sort order | |
| limit | No | Maximum number of results to return | |
| fields | No | Comma-separated list of fields to return | |
| offset | No | Offset for pagination | |
| status | No | Only return deals with this status. For deleted deals use includeDeleted=1 (the API's "Deleted" value does not filter — it returns all statuses). | |
| userId | No | Return deals assigned to a specific user | |
| stageId | No | Filter by stage (numeric stage ID) | |
| personId | No | Return deals linked to a specific person | |
| pipelineId | No | Filter by pipeline | |
| includeDeleted | No | Set to 1 to include deals with status Deleted (default 0) | |
| includeArchived | No | Set to 1 to include deals with status Archived (default 0) |