Logo
Zoom Public API Documentation

Zoom Events API

Number of APIs: 32


1. zoom_events-hubs - List hubs

GET {{baseUrl}}/zoom_events/hubs?role_type=host

Use this API to retrieve event hubs.

Scopes: zoom_events_hubs:readzoom_events_hubs:read:admin

Rate Limit Label: Light



2. zoom_events-events-{eventId}-tickets-{ticketId} - Get a ticket

GET {{baseUrl}}/zoom_events/events/:eventId/tickets/:ticketId

Use this API to get information on a specific ticket.

Scopes: zoom_events_tickets:readzoom_events_tickets:read:admin

Rate Limit Label: LIGHT



3. zoom_events-events-{eventId}-tickets-{ticketId} - Delete a ticket

DELETE {{baseUrl}}/zoom_events/events/:eventId/tickets/:ticketId

Use this API to delete a ticket.

Scopes: zoom_events_tickets:writezoom_events_tickets:write:admin

Rate Limit Label: Light



4. zoom_events-events-{eventId}-tickets - List tickets

GET {{baseUrl}}/zoom_events/events/:eventId/tickets?external_ticket_id=<string>&email=<string>&ticket_type_id=<string>&next_page_token=<string>&page_size=30

Use this API to retrieve the ticket information of an event.

Scopes: zoom_events_tickets:readzoom_events_tickets:read:admin

Rate Limit Label: LIGHT



5. zoom_events-events-{eventId}-tickets - Create tickets

POST {{baseUrl}}/zoom_events/events/:eventId/tickets

Use this API to create tickets for an event. You can add a single ticket or up to 30 tickets in a batch operation. Please note that this request uses the pre-registration flow.

Scopes: zoom_events_tickets:writezoom_events_tickets:write:admin

Rate Limit Label: LIGHT



6. zoom_events-events-{eventId}-ticket_types-{ticketTypeId}-questions - List registration questions for ticket type

GET {{baseUrl}}/zoom_events/events/:eventId/ticket_types/:ticketTypeId/questions

Use this API to list registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level.

Scopes: zoom_events_ticket_types:readzoom_events_ticket_types:read:admin

Rate Limit Label: Light



7. zoom_events-events-{eventId}-ticket_types-{ticketTypeId}-questions - Update registration questions for ticket type

PUT {{baseUrl}}/zoom_events/events/:eventId/ticket_types/:ticketTypeId/questions

Use this API to update registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level. This API is not allowed for single session event type.

Scopes: zoom_events_ticket_types:write:adminzoom_events_ticket_types:write

Rate Limit Label: LIGHT



8. zoom_events-events-{eventId}-ticket_types-{ticketTypeId} - Delete a ticket type

DELETE {{baseUrl}}/zoom_events/events/:eventId/ticket_types/:ticketTypeId

Use this API to delete a ticket type of an event. This API is not allowed for single session event type.

Scopes: zoom_events_ticket_types:write:adminzoom_events_ticket_types:write

Rate Limit Label: LIGHT



9. zoom_events-events-{eventId}-ticket_types-{ticketTypeId} - Update ticket type for an event

PATCH {{baseUrl}}/zoom_events/events/:eventId/ticket_types/:ticketTypeId

Use this API to update the ticket type for an event ID. This API is not allowed for single session event type.

Scopes: zoom_events_ticket_types:write:adminzoom_events_ticket_types:write

Rate Limit Label: LIGHT



10. zoom_events-events-{eventId}-ticket_types - List ticket types

GET {{baseUrl}}/zoom_events/events/:eventId/ticket_types

Use this API to list all ticket types associated with an event.

Scopes: zoom_events_ticket_types:read:adminzoom_events_ticket_types:read

Rate Limit Label: LIGHT



11. zoom_events-events-{eventId}-ticket_types - Create an event ticket type

POST {{baseUrl}}/zoom_events/events/:eventId/ticket_types

Use this API to create create a ticket type for the event ID. This API is not allowed for single session event type.

Scopes: zoom_events_ticket_types:write:adminzoom_events_ticket_types:write

Rate Limit Label: LIGHT



12. zoom_events-events-{eventId}-sessions-{sessionId}-polls - List session polls

GET {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId/polls

List all the polls of a session.

Scopes: zoom_events_sessions:readzoom_events_sessions:read:admin

Rate Limit Label: Light



13. zoom_events-events-{eventId}-sessions-{sessionId}-polls - Create or update session polls.

PUT {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId/polls

Use this API to create or update the list of polls for the session.

Scopes: zoom_events_sessions:writezoom_events_sessions:write:admin

Rate Limit Label: Light



14. zoom_events-events-{eventId}-sessions-{sessionId}-join_token - Get ticket session join token by Event ID and Session ID

GET {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId/join_token

Retrieves the join token to join an event session.

Scopes: zoom_events_sessions:readzoom_events_sessions:read:admin

Rate Limit Label: Light



15. zoom_events-events-{eventId}-sessions-{sessionId}-interpreters - List session interpreters

GET {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId/interpreters

Use this API to retrieve interpreters in a session.

Scopes: zoom_events_sessions:readzoom_events_sessions:read:admin

Rate Limit Label: Light



16. zoom_events-events-{eventId}-sessions-{sessionId}-interpreters - Create or update session interpreters.

PUT {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId/interpreters

Use this API to create or update the list of interpreters for the session.

Scopes: zoom_events_sessions:write:adminzoom_events_sessions:write

Rate Limit Label: LIGHT



17. zoom_events-events-{eventId}-sessions-{sessionId}-attendees - List session attendees

GET {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId/attendees?page_size=30&next_page_token=<string>

Use this API to retrieve session attendees.

Scopes: zoom_events_registrants:readzoom_events_registrants:read:admin

Rate Limit Label: Light



18. zoom_events-events-{eventId}-sessions-{sessionId} - Get the session information

GET {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId

Use this API to get the session information.

Scopes: zoom_events_sessions:readzoom_events_sessions:read:admin

Rate Limit Label: LIGHT



19. zoom_events-events-{eventId}-sessions-{sessionId} - Delete a session

DELETE {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId

Use this API to delete a session. This API is not allowed for single session event type.

Scopes: zoom_events_sessions:write:adminzoom_events_sessions:write

Rate Limit Label: LIGHT



20. zoom_events-events-{eventId}-sessions-{sessionId} - Update a session

PATCH {{baseUrl}}/zoom_events/events/:eventId/sessions/:sessionId

Use this API to update an existing session in an event. This API is not allowed for single session event type.

Scopes: zoom_events_sessions:write:adminzoom_events_sessions:write

Rate Limit Label: LIGHT



21. zoom_events-events-{eventId}-sessions - List sessions

GET {{baseUrl}}/zoom_events/events/:eventId/sessions

Use this API to retrieve sessions in an event.

Scopes: zoom_events_sessions:readzoom_events_sessions:read:admin

Rate Limit Label: LIGHT



22. zoom_events-events-{eventId}-sessions - Create a session

POST {{baseUrl}}/zoom_events/events/:eventId/sessions

Use this API to create a session. This API is not allowed for single session event type.

Scopes: zoom_events_sessions:write:adminzoom_events_sessions:write

Rate Limit Label: LIGHT



23. zoom_events-events-{eventId}-reports-ticket_registration - Event Registrations Report

GET {{baseUrl}}/zoom_events/events/:eventId/reports/ticket_registration?page_size=30&next_page_token=<string>

Use this API to retrieve event ticket registrations.

Scopes: zoom_events_reports.readzoom_events_reports:read:admin

Rate Limit Label: HEAVY



24. zoom_events-events-{eventId}-reports-event_attendance - Event Attendance Report

GET {{baseUrl}}/zoom_events/events/:eventId/reports/event_attendance?page_size=30&next_page_token=<string>

Use this API to retrieve event attendance report.

Scopes: zoom_events_reports:read:adminzoom_events_reports:read

Rate Limit Label: HEAVY



25. zoom_events-events-{eventId}-registrants - List registrants

GET {{baseUrl}}/zoom_events/events/:eventId/registrants?page_size=30&next_page_token=<string>

Use this API to retrieve event registrants.

Scopes: zoom_events_registrants:readzoom_events_registrants:read:admin

Rate Limit Label: Light



26. zoom_events-events-{eventId}-questions - List registration questions for an event

GET {{baseUrl}}/zoom_events/events/:eventId/questions

Use this API to list registration questions and fields that are to be answered by users while registering for an event. These questions are setup at event level.

Scopes: zoom_events_ticket_types:readzoom_events_ticket_types:read:admin

Rate Limit Label: Light



27. zoom_events-events-{eventId}-questions - Update registration questions for an event

PUT {{baseUrl}}/zoom_events/events/:eventId/questions

Use this API to update registration questions and fields that are to be answered by users while registering for an event. These questions are setup at event level.

Scopes: zoom_events_ticket_types:writezoom_events_ticket_types:write:admin

Rate Limit Label: Light



28. zoom_events-events-{eventId} - Get an event

GET {{baseUrl}}/zoom_events/events/:eventId

Use this API to get information on a specified event.

Scopes: zoom_events_basic:readzoom_events_basic:read:admin

Rate Limit Label: Light



29. zoom_events-events-{eventId} - Delete an event

DELETE {{baseUrl}}/zoom_events/events/:eventId

Use this API to delete a draft event.

Scopes: zoom_events_basic:writezoom_events_basic:write:admin

Rate Limit Label: LIGHT



30. zoom_events-events-{eventId} - Update an event

PATCH {{baseUrl}}/zoom_events/events/:eventId

Use this API to update an event.

Scopes: zoom_events_basic:writezoom_events_basic:write:admin

Rate Limit Label: LIGHT



31. zoom_events-events - 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:readzoom_events_basic:read:admin

Rate Limit Label: Light



32. zoom_events-events - Create an event

POST {{baseUrl}}/zoom_events/events

Use this API to create an event.

Scopes: zoom_events_basic:writezoom_events_basic:write:admin

Rate Limit Label: LIGHT



ENDPOINTS