Zoom Public API Documentation
List registrants
GET {{baseUrl}}/zoom_events/events/:eventId/registrants?page_size=30&next_page_token=<string>
Use this API to retrieve event registrants. Scopes: Rate Limit Label: zoom_events_registrants:readzoom_events_registrants:read:adminLight
Body
PARAM
| 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": "<number>",
"next_page_token": "<string>",
"registrants": [
{
"email": "<string>",
"registration_status": "PRE_REGISTER_INVITED",
"tickets": [
{
"ticket_id": "<string>",
"role": "GUEST"
},
{
"ticket_id": "<string>",
"role": "ORIGINAL_HOST"
}
]
},
{
"email": "<string>",
"registration_status": "GIFTED",
"tickets": [
{
"ticket_id": "<string>",
"role": "PANELIST"
},
{
"ticket_id": "<string>",
"role": "INTERPRETER"
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/zoom_events/events/:eventId/registrants?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS