List deals
GET {{baseUrl}}/iq/deals?deal_name=<string>&only_show_with_analytics=<boolean>&from=<string>&to=<string>&team_id=<string>&deal_stage=<string>&owner_id=<string>&page_size=30&next_page_token=<integer>&max_deal_amount=<integer>&min_deal_amount=<string>
List all deals.
Scopes: iq_deal:read:admin,iq_deal:read
Rate Limit Label: MEDIUM
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
deal_name | string | The deal name | |
only_show_with_analytics | string | Set to true to return deals with analytics. | |
from | string | The start date in yyyy-MM-dd'T'HH:mm:ss'Z' format. | |
to | string | The end date in yyyy-MM-dd'T'HH:mm:ss'Z' format. | |
team_id | string | The Zoom specific team ID to query. | |
deal_stage | string | The stage of the deal. | |
owner_id | string | The Zoom specific user ID to query. | |
page_size | number | The number of records returned within a single API call. | |
next_page_token | string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
max_deal_amount | string | The maximum deal amount to query. | |
min_deal_amount | string | The minimum deal amount to query. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"deals":[{"deal_id":"\u003cstring\u003e","deal_name":"\u003cstring\u003e","deal_stage":"\u003cstring\u003e","deal_description":"\u003cstring\u003e","owner_name":"\u003cstring\u003e","owner_email":"\u003cstring\u003e","owner_id":"\u003cstring\u003e","deal_is_closed":"\u003cboolean\u003e","create_time":"\u003cdateTime\u003e","account_name":"\u003cstring\u003e","deal_is_private":"\u003cboolean\u003e","deal_amount":"\u003cinteger\u003e","currency_type":"\u003cstring\u003e","close_date":"\u003cstring\u003e","time_in_stage":"\u003cinteger\u003e","number_of_conversations":"\u003cinteger\u003e","last_activity_time":"\u003cdateTime\u003e","account_type":"\u003cstring\u003e"},{"deal_id":"\u003cstring\u003e","deal_name":"\u003cstring\u003e","deal_stage":"\u003cstring\u003e","deal_description":"\u003cstring\u003e","owner_name":"\u003cstring\u003e","owner_email":"\u003cstring\u003e","owner_id":"\u003cstring\u003e","deal_is_closed":"\u003cboolean\u003e","create_time":"\u003cdateTime\u003e","account_name":"\u003cstring\u003e","deal_is_private":"\u003cboolean\u003e","deal_amount":"\u003cinteger\u003e","currency_type":"\u003cstring\u003e","close_date":"\u003cstring\u003e","time_in_stage":"\u003cinteger\u003e","number_of_conversations":"\u003cinteger\u003e","last_activity_time":"\u003cdateTime\u003e","account_type":"\u003cstring\u003e"}]}