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:
zoom_events_basic:read
zoom_events_basic:read:admin
Rate Limit Label
:
Light
Request Params
| 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":"\u003cnumber\u003e","next_page_token":"\u003cstring\u003e","events":[{"event_id":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","timezone":"\u003cstring\u003e","event_type":"\u003cstring\u003e","access_level":"\u003cstring\u003e","meeting_type":"\u003cstring\u003e","categories":["\u003cstring\u003e","\u003cstring\u003e"],"tags":["\u003cstring\u003e","\u003cstring\u003e"],"calendar":[{"start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e"},{"start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e"}],"status":"\u003cstring\u003e","hub_id":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e","contact_name":"\u003cstring\u003e","contact_email":"\u003cstring\u003e","lobby_start_time":"\u003cdateTime\u003e","lobby_end_time":"\u003cdateTime\u003e","event_url":"\u003cstring\u003e","blocked_countries":["\u003cstring\u003e","\u003cstring\u003e"]},{"event_id":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","timezone":"\u003cstring\u003e","event_type":"\u003cstring\u003e","access_level":"\u003cstring\u003e","meeting_type":"\u003cstring\u003e","categories":["\u003cstring\u003e","\u003cstring\u003e"],"tags":["\u003cstring\u003e","\u003cstring\u003e"],"calendar":[{"start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e"},{"start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e"}],"status":"\u003cstring\u003e","hub_id":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","end_time":"\u003cdateTime\u003e","contact_name":"\u003cstring\u003e","contact_email":"\u003cstring\u003e","lobby_start_time":"\u003cdateTime\u003e","lobby_end_time":"\u003cdateTime\u003e","event_url":"\u003cstring\u003e","blocked_countries":["\u003cstring\u003e","\u003cstring\u003e"]}]}