Zoom Public API Documentation
List events
GET {{baseUrl}}/zoom_events/events?role_type=attendee&event_status_type=upcoming&page_size=30&next_page_token=<string>
Use this API to retrieve all events associated with the user. Scopes: Rate Limit Label: zoom_events_basic:readzoom_events_basic:read:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
role_type
|
string | The user role type: * `host` — All hosted events. * `attendee` — All non-hosted ticketed events. | |
event_status_type
|
string | The type of event status: * `upcoming` — All upcoming events. * `past` — All past events. * `draft` — All events marked as draft. * `cancelled` — All cancelled events. For the `ATTENDEE` role type, only `upcoming` and `past` are valid status types. As a `HOST`, all status types are valid. | |
page_size
|
number | The number of records returned in a single API call. | |
next_page_token
|
string | The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"total_records": "<number>",
"next_page_token": "<string>",
"events": [
{
"event_id": "<string>",
"name": "<string>",
"description": "<string>",
"timezone": "<string>",
"event_type": "<string>",
"access_level": "<string>",
"meeting_type": "<string>",
"categories": [
"<string>",
"<string>"
],
"tags": [
"<string>",
"<string>"
],
"calendar": [
{
"start_time": "<dateTime>",
"end_time": "<dateTime>"
},
{
"start_time": "<dateTime>",
"end_time": "<dateTime>"
}
],
"status": "<string>",
"hub_id": "<string>",
"start_time": "<dateTime>",
"end_time": "<dateTime>",
"contact_name": "<string>",
"contact_email": "<string>",
"lobby_start_time": "<dateTime>",
"lobby_end_time": "<dateTime>",
"event_url": "<string>",
"blocked_countries": [
"<string>",
"<string>"
]
},
{
"event_id": "<string>",
"name": "<string>",
"description": "<string>",
"timezone": "<string>",
"event_type": "<string>",
"access_level": "<string>",
"meeting_type": "<string>",
"categories": [
"<string>",
"<string>"
],
"tags": [
"<string>",
"<string>"
],
"calendar": [
{
"start_time": "<dateTime>",
"end_time": "<dateTime>"
},
{
"start_time": "<dateTime>",
"end_time": "<dateTime>"
}
],
"status": "<string>",
"hub_id": "<string>",
"start_time": "<dateTime>",
"end_time": "<dateTime>",
"contact_name": "<string>",
"contact_email": "<string>",
"lobby_start_time": "<dateTime>",
"lobby_end_time": "<dateTime>",
"event_url": "<string>",
"blocked_countries": [
"<string>",
"<string>"
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/zoom_events/events?role_type=attendee&event_status_type=upcoming&page_size=30&next_page_token=<string>?role_type=attendee&event_status_type=upcoming&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS