GET /webinars/{webinarId}/registrants

Zoom users with a Webinar Plan 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 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:

Servers

Path parameters

Name Type Required Description
webinarId Integer Yes

The webinar ID in "long" format(represented as int64 data type in JSON).

Query parameters

Name Type Required Description
tracking_source_id String No

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_number Integer No

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.

Default value: 1

page_size Integer No

The number of records returned within a single API call.

Default value: 30

status String No

The registrant status:
pending - Registrant's status is pending.
approved - Registrant's status is approved.
denied - Registrant's status is denied.

Valid values:

  • "approved"
  • "pending"
  • "denied"

Default value: "approved"

next_page_token String No

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.

occurrence_id String No

The meeting occurrence ID.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.