List Deals
Deals
List Deals
Retrieve a paginated list of deals in your workspace
GET
List Deals
Request
Query Parameters
Page number for pagination
Number of deals per page (max: 100)
Filter by status (e.g.,
active, won, lost)Filter by pipeline name
Filter by stage name
Filter by main contact ID
Filter by deal owner user ID
Filter by tag
Filter deals created after this date (ISO 8601)
Filter deals created before this date (ISO 8601)
Filter deals updated after this date (ISO 8601)
Headers
Response
Pagination metadata
Example Response
Errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing deals:read permission |
| 429 | rate_limited | Rate limit exceeded |