List Deals
Retrieve a list of deals for your organization with optional filtering and pagination.
Endpoint
GET/deals
Request
Response
json
Query Parameters
| Parameter | Type | Description |
|---|---|---|
organization_id | Number | ID of the organization to fetch deals for (required) |
status | String | Filter deals by status ('open', 'won', 'lost') |
pipeline_id | Number | Filter deals by pipeline ID |
pipeline_stage_id | Number | Filter deals by pipeline stage ID |
$limit | Number | Number of deals to return (default: 10) |
$skip | Number | Number of deals to skip (for pagination) |
$sort | Object | Sort criteria (e.g., { "created_at": -1 } for newest first) |
fastJoinForDealsList | Boolean | Include associated data like company, contact, pipeline stage, and owner (recommended) |
Report an issue with this documentation
Please log in to report issues with our documentation.