Zoom Public API Documentation
List webinars
GET {{baseUrl}}/metrics/webinars?type=live&from=<date>&to=<date>&page_size=30&next_page_token=<string>&group_id=<string>
Lists all the live or past webinars from a specified period of time. Prerequisites Scopes: Rate Limit Label:
dashboard_webinars:read:admin,dashboard:read:adminRESOURCE-INTENSIVE
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The type of webinar to query. * `past` - All past webinars. * `live` - All live webinars. This value defaults to `live`. | |
from
|
string | (Required) The start date in 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'format. The date range defined by the `from` and `to` parameters should only be one month, as the report includes only one month's worth of data at once. | |
to
|
string | (Required) The end date 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
group_id
|
string | The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. **Note:** The API response will only contain meetings where the host is a member of the queried group ID. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<date>",
"to": "<date>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": 30,
"total_records": "<integer>",
"webinars": [
{
"host": "<string>",
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"dept": "<string>",
"duration": "<string>",
"email": "<string>",
"end_time": "<dateTime>",
"has_3rd_party_audio": "<boolean>",
"has_archiving": "<boolean>",
"has_pstn": "<boolean>",
"has_recording": "<boolean>",
"has_screen_share": "<boolean>",
"has_sip": "<boolean>",
"has_video": "<boolean>",
"has_voip": "<boolean>",
"has_manual_captions": "<boolean>",
"has_automated_captions": "<boolean>",
"id": "<long>",
"participants": "<integer>",
"start_time": "<dateTime>",
"topic": "<string>",
"user_type": "<string>",
"uuid": "<string>",
"audio_quality": "poor",
"video_quality": "good",
"screen_share_quality": "bad"
},
{
"host": "<string>",
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"dept": "<string>",
"duration": "<string>",
"email": "<string>",
"end_time": "<dateTime>",
"has_3rd_party_audio": "<boolean>",
"has_archiving": "<boolean>",
"has_pstn": "<boolean>",
"has_recording": "<boolean>",
"has_screen_share": "<boolean>",
"has_sip": "<boolean>",
"has_video": "<boolean>",
"has_voip": "<boolean>",
"has_manual_captions": "<boolean>",
"has_automated_captions": "<boolean>",
"id": "<long>",
"participants": "<integer>",
"start_time": "<dateTime>",
"topic": "<string>",
"user_type": "<string>",
"uuid": "<string>",
"audio_quality": "good",
"video_quality": "good",
"screen_share_quality": "bad"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/webinars?type=live&from=<date>&to=<date>&page_size=30&next_page_token=<string>&group_id=<string>?type=live&from=<date>&to=<date>&page_size=30&next_page_token=<string>&group_id=<string>' -H 'Accept: application/json'
ENDPOINTS