List webinar registrants
GET {{baseUrl}}/webinars/:webinarId/registrants?occurrence_id=<string>&status=approved&tracking_source_id=<string>&page_size=30&page_number=1&next_page_token=<string>
List all users that have registered for a given webinar. Zoom users with a webinar plan have access to creating and managing webinars. The webinar functionality lets a host broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a webinar with registration requires your registrants to complete a brief form before receiving the link to join the webinar.
Prerequisites
- Pro or higher plan with a Webinar Add-on.
Scopes:
webinar:read:admin
,
webinar:read
Rate Limit Label
:
MEDIUM
Request Params
| 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. | |tracking_source_id| string | | The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See Creating source tracking links for webinar registration for details. | |page_size| number | | The number of records returned within a single API call. | |page_number| number | | Deprecated This field will be deprecated. We will no longer support this field in a future release. Instead, use thenext_page_tokenfor 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":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_number":1,"page_size":30,"total_records":"\u003cinteger\u003e","registrants":[{"email":"\u003cemail\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","address":"\u003cstring\u003e","city":"\u003cstring\u003e","comments":"\u003cstring\u003e","country":"\u003cstring\u003e","custom_questions":[{"title":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"industry":"\u003cstring\u003e","job_title":"\u003cstring\u003e","last_name":"\u003cstring\u003e","no_of_employees":"51-100","org":"\u003cstring\u003e","phone":"\u003cstring\u003e","purchasing_time_frame":"No timeframe","role_in_purchase_process":"Influencer","state":"\u003cstring\u003e","status":"approved","zip":"\u003cstring\u003e","create_time":"\u003cdateTime\u003e","join_url":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","address":"\u003cstring\u003e","city":"\u003cstring\u003e","comments":"\u003cstring\u003e","country":"\u003cstring\u003e","custom_questions":[{"title":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"title":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"industry":"\u003cstring\u003e","job_title":"\u003cstring\u003e","last_name":"\u003cstring\u003e","no_of_employees":"5,001-10,000","org":"\u003cstring\u003e","phone":"\u003cstring\u003e","purchasing_time_frame":"No timeframe","role_in_purchase_process":"Influencer","state":"\u003cstring\u003e","status":"approved","zip":"\u003cstring\u003e","create_time":"\u003cdateTime\u003e","join_url":"\u003cstring\u003e"}]}