listWebinarRegistrants.Rd
Zoom users with a Webinar Plan https://zoom.us/webinar have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration https://support.zoom.us/hc/enus/articles/204619915SchedulingaWebinarwithRegistration requires your registrants to complete a brief form before receiving the link to join the Webinar.Use this API to list all the users that have registered for a webinar.**Prerequisites:*** Pro or higher plan with a Webinar Addon.**Scopes:** webinar:read:admin webinar:read ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium
listWebinarRegistrants( webinarId, occurrence_id = NULL, status = NULL, page_size = NULL, page_number = NULL, next_page_token = NULL, return_response = F )
webinarId | The webinar ID in "**long**" format represented as int64 data type in JSON . |
---|---|
occurrence_id | The meeting occurrence ID. |
status | The registrant status:pending Registrant's status is pending.approved Registrant's status is approved.denied Registrant's status is denied. |
page_size | The number of records returned within a single API call. |
page_number | **Deprecated** This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.The page number of the current page in the returned records. |
next_page_token | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
return_response | Whether to return the response instead of the response content. Defaults to FALSE. |