Deal Read Tool
deal-readList or show sales deals. Multiple deals can belong to the same contact (user_id), including opportunities whose end-client is not known. List supports filters, sorting, pagination and an optional pipeline_id. Responses include visible pipeline card IDs for pipeline-item-write moves. Deal values require invoice access. Use deal-activity-read and deal-message-read with deal_id to read its activities and conversation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for "list". Default 1. | |
| sort | No | Sort fields for "list". Append :asc or :desc for direction (default :asc). Example: ["created_at:desc"]. Available fields: id, user_id, company_id, owner_id, created_by, service_id, title, status, expected_close_date, closed_at, created_at, updated_at. | |
| limit | No | Results per page for "list". Default 20, max 100. | |
| action | Yes | Action to perform. | |
| deal_id | No | Deal id. Required for "show" actions. | |
| filters | No | Purity filter object for "list". Keys are field names, values are operator objects. Example: {"status":{"$eq":1}}. Available fields: id, user_id, company_id, owner_id, created_by, service_id, title, status, expected_close_date, closed_at, created_at, updated_at. Deal status values are open, won and lost. Monetary fields are not filterable or sortable. | |
| pipeline_id | No | For list, restrict to deals on this visible sales pipeline. |