Get Deals
list_dealsRetrieve CRM deals with optional filters by pipeline, phase, or contact, plus pagination and sorting by creation, update, or closing date.
Instructions
Get Deals.
Returns a list of deals
For more flexible filtering and sorting, use POST /v1/deal/search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (0 is the first page) | |
| sortBy | No | Sorts the result list by the selected sort criterion. | createdAt |
| phaseId | No | When the phase ID is provided, only deals from that phase are returned. | |
| pageSize | No | Items per page (1-100) | |
| contactId | No | When the contact ID is provided, only deals associated with that contact are returned. | |
| sortOrder | No | Defines the sort direction for the result list. | desc |
| pipelineId | No | When the pipeline ID is provided, only deals from that pipeline are returned. |