Zoom Public API Documentation
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: Rate Limit Label: iq_deal:read:admin,iq_deal:readMEDIUM
Body
PARAM
| 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": "<string>",
"page_size": 30,
"deals": [
{
"deal_id": "<string>",
"deal_name": "<string>",
"deal_stage": "<string>",
"deal_description": "<string>",
"owner_name": "<string>",
"owner_email": "<string>",
"owner_id": "<string>",
"deal_is_closed": "<boolean>",
"create_time": "<dateTime>",
"account_name": "<string>",
"deal_is_private": "<boolean>",
"deal_amount": "<integer>",
"currency_type": "<string>",
"close_date": "<string>",
"time_in_stage": "<integer>",
"number_of_conversations": "<integer>",
"last_activity_time": "<dateTime>",
"account_type": "<string>"
},
{
"deal_id": "<string>",
"deal_name": "<string>",
"deal_stage": "<string>",
"deal_description": "<string>",
"owner_name": "<string>",
"owner_email": "<string>",
"owner_id": "<string>",
"deal_is_closed": "<boolean>",
"create_time": "<dateTime>",
"account_name": "<string>",
"deal_is_private": "<boolean>",
"deal_amount": "<integer>",
"currency_type": "<string>",
"close_date": "<string>",
"time_in_stage": "<integer>",
"number_of_conversations": "<integer>",
"last_activity_time": "<dateTime>",
"account_type": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/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>?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>' -H 'Accept: application/json'
ENDPOINTS