pipelines_deals
List deals in a specific pipeline, filtering by stage, user, or custom filter. Supports pagination and pipeline summary.
Instructions
Get all deals in a specific pipeline.
Returns a list of deals in the pipeline with optional filtering by stage, user, or custom filter. Includes pagination support and optional summary statistics.
Workflow tips:
Filter by stage_id to see deals in specific stage
Use everyone=1 to see all deals (ignores filter_id and user_id)
Set get_summary=1 to include pipeline totals in additional_data
Use totals_convert_currency to convert values to specific currency
Supports pagination with start and limit parameters
Can apply custom filters with filter_id
Common use cases:
Get all deals in pipeline: { "id": 1 }
Get deals in specific stage: { "id": 1, "stage_id": 5 }
Get deals for user: { "id": 1, "user_id": 123 }
Get everyone's deals with summary: { "id": 1, "everyone": 1, "get_summary": 1 }
Paginated results: { "id": 1, "start": 0, "limit": 50 }
Convert to USD: { "id": 1, "totals_convert_currency": "USD", "get_summary": 1 }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the pipeline | |
| filter_id | No | Only return deals matching this filter | |
| user_id | No | Only return deals owned by this user (defaults to authorized user) | |
| everyone | No | Set to 1 to return deals owned by everyone (ignores filter_id and user_id) | |
| stage_id | No | Only return deals in this specific stage | |
| start | No | Pagination start offset (default: 0) | |
| limit | No | Number of items per page | |
| get_summary | No | Set to 1 to include pipeline summary in additional_data | |
| totals_convert_currency | No | 3-letter currency code (e.g., USD, EUR) or "default_currency" |