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:read
zoom_events_registrants:read:admin
Rate Limit Label: Light
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
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","registrants":[{"email":"\u003cstring\u003e","registration_status":"PRE_REGISTER_INVITED","tickets":[{"ticket_id":"\u003cstring\u003e","role":"GUEST"},{"ticket_id":"\u003cstring\u003e","role":"ORIGINAL_HOST"}]},{"email":"\u003cstring\u003e","registration_status":"GIFTED","tickets":[{"ticket_id":"\u003cstring\u003e","role":"PANELIST"},{"ticket_id":"\u003cstring\u003e","role":"INTERPRETER"}]}]}