Zoom Public API Documentation
List meeting registrants
GET {{baseUrl}}/meetings/:meetingId/registrants?occurrence_id=<string>&status=approved&page_size=30&page_number=1&next_page_token=<string>
A host or a user with admin permission can require registration for a Zoom meeting. List users that have registered for a meeting. Scopes: Rate Limit Label: meeting:read:admin,meeting:readMedium
Body
PARAM
| Key | Datatype | Required | Description |
occurrence_id
|
string | The meeting or webinar occurrence ID. | |
status
|
string | Query by the registrant's status. * `pending` - The registration is pending. * `approved` - The registrant is approved. * `denied` - The registration is denied. | |
page_size
|
number | The number of records returned within a single API call. | |
page_number
|
number | **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_count": "<integer>",
"page_number": 1,
"page_size": 30,
"total_records": "<integer>",
"registrants": [
{
"email": "<email>",
"first_name": "<string>",
"id": "<string>",
"address": "<string>",
"city": "<string>",
"comments": "<string>",
"country": "<string>",
"custom_questions": [
{
"title": "<string>",
"value": "<string>"
},
{
"title": "<string>",
"value": "<string>"
}
],
"industry": "<string>",
"job_title": "<string>",
"last_name": "<string>",
"no_of_employees": "1,001-5,000",
"org": "<string>",
"phone": "<string>",
"purchasing_time_frame": "",
"role_in_purchase_process": "Decision Maker",
"state": "<string>",
"status": "denied",
"zip": "<string>",
"create_time": "<dateTime>",
"join_url": "<string>",
"participant_pin_code": "<long>"
},
{
"email": "<email>",
"first_name": "<string>",
"id": "<string>",
"address": "<string>",
"city": "<string>",
"comments": "<string>",
"country": "<string>",
"custom_questions": [
{
"title": "<string>",
"value": "<string>"
},
{
"title": "<string>",
"value": "<string>"
}
],
"industry": "<string>",
"job_title": "<string>",
"last_name": "<string>",
"no_of_employees": "1-20",
"org": "<string>",
"phone": "<string>",
"purchasing_time_frame": "1-3 months",
"role_in_purchase_process": "Not involved",
"state": "<string>",
"status": "pending",
"zip": "<string>",
"create_time": "<dateTime>",
"join_url": "<string>",
"participant_pin_code": "<long>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/meetings/:meetingId/registrants?occurrence_id=<string>&status=approved&page_size=30&page_number=1&next_page_token=<string>?occurrence_id=<string>&status=approved&page_size=30&page_number=1&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS