Search and Analyze Deals
get_dealsRead-onlyIdempotent
Search, filter, count activity, group, rank, and return open/won/lost CRM deals. Open deals include manual forecast_status and AI forecast_category. Choose one owner selector. For broader AI analysis, inspect deals/analysis_concepts in the catalog.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| columns | No | Optional Deal fields; omit for the compact default. row_count and amount_sum are grouped metrics. | |
| sort_by | No | Sort by a catalog-supported Deal field. | |
| deal_ids | No | ||
| group_by | No | ||
| team_ids | No | Exclusive selector: exact team IDs, expanded to active owners. | |
| deal_name | No | ||
| owner_ids | No | Exclusive selector: exact IDs from the owners catalog. | |
| page_size | No | Row size 1-100; use page/page_size. Groups use group_page_size. | |
| owner_scope | No | Exclusive selector: all owners or current authenticated user. | |
| amount_range | No | Inclusive configured Deal-value range. | |
| deal_statuses | No | ||
| group_sort_by | No | Required with group_by: row_count, amount_sum, label, or value_order. rows, amount, and revenue are aliases. | |
| company_filter | No | ||
| contact_filter | No | ||
| sort_direction | No | asc | |
| deal_name_match | No | contains | |
| forecast_status | No | ||
| group_page_size | No | ||
| pipeline_stages | No | ||
| purchase_intent | No | ||
| activity_filters | No | Up to 10 ANDed per-deal count filters. Item: {activity_types:[...],count:{operator,value},time_range:{start_date,end_date}}. For no activity use activity_types:["any"], count:{operator:"eq",value:0}, and dates. any counts meetings, calls, sent or received customer emails, and communications; zero includes never-contacted deals. | |
| close_date_range | No | ||
| custom_properties | No | ||
| forecast_category | No | ||
| sales_performance | No | ||
| overall_deal_health | No | ||
| competitive_position | No | ||
| deal_progress_status | No | ||
| group_sort_direction | No | desc | |
| close_date_confidence | No | ||
| deal_stage_confidence | No | ||
| deal_probability_range | No | ||
| custom_property_filters | No | ||
| include_null_close_date | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| kind | Yes | ||
| tool | Yes | ||
| summary | Yes | ||
| result_id | No | ||
| limitations | No |