Zoom Public API Documentation
Get upcoming events report
GET {{baseUrl}}/report/upcoming_events?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=all&group_id=<string>
Use this API to list upcoming meeting and/or webinar events within a specified period of time. The report's time range is limited to one month. Prerequisites:
* A Pro or higher plan Scopes: Rate Limit Label: report:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (Required) Start date in '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 worth of data at once. | |
to
|
string | (Required) End date. | |
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. | |
type
|
string | The type of event to query. * `meeting` — A meeting event. * `webinar` — A webinar event. * `all` — Both meeting and webinar events. This value defaults to `all`. | |
group_id
|
string | The group ID. To get a group ID, use the [**List groups**](/api-reference/zoom-api/methods#operation/groups) 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>",
"next_page_token": "<string>",
"page_size": 30,
"to": "<date>",
"upcoming_events": [
{
"dept": "<string>",
"host_id": "<string>",
"host_name": "<string>",
"id": "<string>",
"start_time": "<string>",
"topic": "<string>"
},
{
"dept": "<string>",
"host_id": "<string>",
"host_name": "<string>",
"id": "<string>",
"start_time": "<string>",
"topic": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/report/upcoming_events?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=all&group_id=<string>?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=all&group_id=<string>' -H 'Accept: application/json'
ENDPOINTS