List deals
pipelinecrm_list_dealsRead-only
List or search deals with stage, owner, company, primary contact, value, probability and expected close date. Filter by name, stage, pipeline, status, owner, company, contact, archived flag, value range and created, expected-close, closed or modified dates. Money values come back as decimal strings. GET /deals.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Deals whose name contains this text. | |
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| sort | No | Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>. | |
| archived | No | true = archived deals only, false = not archived only. | |
| owner_id | No | Only deals owned by this user id. | |
| per_page | No | Results per page, 1-200 (default 25). | |
| stage_id | No | Only deals in this deal stage id (see pipelinecrm_list_deal_stages). | |
| max_value | No | Only deals worth at most this much. | |
| min_value | No | Only deals worth at least this much. | |
| status_id | No | Only deals with this deal status id (open, won, lost... see pipelinecrm_list_lookup with kind deal_statuses). | |
| pipeline_id | No | Only deals in this deal pipeline id (see pipelinecrm_list_deal_pipelines). | |
| closed_after | No | Closed (won or lost) on or after this date (yyyy-mm-dd). | |
| company_name | No | Only deals whose company name contains this text. | |
| closed_before | No | Closed (won or lost) on or before this date (yyyy-mm-dd). | |
| created_after | No | Created on or after this date (yyyy-mm-dd). | |
| created_before | No | Created on or before this date (yyyy-mm-dd). | |
| modified_after | No | Modified on or after this date (yyyy-mm-dd). | |
| primary_contact_id | No | Only deals whose primary contact is this person id. | |
| expected_close_after | No | Expected to close on or after this date (yyyy-mm-dd). | |
| expected_close_before | No | Expected to close on or before this date (yyyy-mm-dd). |