GET metrics/webinars/{webinarId}/participants

zoom.us

Summary: Get webinar participants
Operation ID: dashboardWebinarParticipants
Auth: unknown
Description

Retrieve details on participants from live or past webinars.<br><br> **Scopes:** `dashboard_webinars:read:admin`<br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br> **Prerequisites:**<br> * Business, Education or API Plan with Webinar add-on.

Parameters (5)

include_fields (string, query, optional)

Provide 'registrant_id' as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a [webinar registrant](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrants).<br>

Constraints: {'enum': ['registrant_id']}

next_page_token (string, query, optional)

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.

page_size (integer, query, optional, default: 30)

The number of records returned within a single API call.

Constraints: {'maximum': 300}

type (string, query, optional, default: live)

The webinar type.

Constraints: {'enum': ['past', 'live']}

webinarId (string, path, required)

The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.

No probe data for this endpoint yet.