Logo
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

  • Business, Education or API Plan with Webinar add-on.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: RESOURCE-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
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