Logo
Zoom Public API Documentation

Get webinar participants

GET {{baseUrl}}/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=<string>&include_fields=registrant_id

Returns information about participants from live or past webinars. Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Note: This API might return empty values for participants' user_name, ip_address, location, and email responses when the account calls this API.

Prerequisites: * A Business, Education, or API Plan with Webinar add-on.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

 

Body PARAM

Key Datatype Required Description  
type
 string The type of webinar to query. * `past` - All past webinars. * `live` - All live webinars. This value defaults to `live`. 
page_size
 number The number of records returned within a single API call. 
next_page_token
 string The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. 
include_fields
 string The additional fields to include in the query. * `registrant_id` - Includes the webinar registrant's ID. The registrant ID is the [webinar registrant's unique ID](/docs/api-reference/zoom-api/methods#operation/webinarRegistrants).



HEADERS

Key Datatype Required Description  
Accept
 string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_count": "<integer>", "page_size": 30, "total_records": "<integer>", "participants": [ { "audio_quality": "poor", "connection_type": "<string>", "customer_key": "<string>", "data_center": "<string>", "device": "H.323/SIP", "domain": "<string>", "email": "<string>", "from_sip_uri": "<string>", "full_data_center": "<string>", "harddisk_id": "<string>", "id": "<string>", "internal_ip_addresses": [ "<string>", "<string>" ], "ip_address": "<string>", "join_time": "<dateTime>", "leave_reason": "Exceeded free webinar minutes limit.", "leave_time": "<dateTime>", "location": "<string>", "mac_addr": "<string>", "microphone": "<string>", "network_type": "PPP", "participant_user_id": "<string>", "pc_name": "<string>", "recording": "<boolean>", "registrant_id": "<string>", "role": "panelist", "screen_share_quality": "bad", "share_application": "<boolean>", "share_desktop": "<boolean>", "share_whiteboard": "<boolean>", "sip_uri": "<string>", "speaker": "<string>", "user_id": "<string>", "user_name": "<string>", "version": "<string>", "video_quality": "poor", "audio_call": [ { "call_number": "<string>", "call_type": "call-in", "zoom_number": "<string>" }, { "call_number": "<string>", "call_type": "call-out", "zoom_number": "<string>" } ], "os": "<string>", "os_version": "<string>", "device_name": "<string>" }, { "audio_quality": "poor", "connection_type": "<string>", "customer_key": "<string>", "data_center": "<string>", "device": "Android", "domain": "<string>", "email": "<string>", "from_sip_uri": "<string>", "full_data_center": "<string>", "harddisk_id": "<string>", "id": "<string>", "internal_ip_addresses": [ "<string>", "<string>" ], "ip_address": "<string>", "join_time": "<dateTime>", "leave_reason": "Leave waiting room.", "leave_time": "<dateTime>", "location": "<string>", "mac_addr": "<string>", "microphone": "<string>", "network_type": "PPP", "participant_user_id": "<string>", "pc_name": "<string>", "recording": "<boolean>", "registrant_id": "<string>", "role": "attendee", "screen_share_quality": "good", "share_application": "<boolean>", "share_desktop": "<boolean>", "share_whiteboard": "<boolean>", "sip_uri": "<string>", "speaker": "<string>", "user_id": "<string>", "user_name": "<string>", "version": "<string>", "video_quality": "good", "audio_call": [ { "call_number": "<string>", "call_type": "call-out", "zoom_number": "<string>" }, { "call_number": "<string>", "call_type": "call-in", "zoom_number": "<string>" } ], "os": "<string>", "os_version": "<string>", "device_name": "<string>" } ] }


Curl
curl -X GET 'https://api.zoom.us/v2/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=<string>&include_fields=registrant_id?type=live&page_size=30&next_page_token=<string>&include_fields=registrant_id' -H 'Accept: application/json'

  • Ask Qodex

  • Introduction

  • FAQs

  • More

    Github

    Developer Website

    Claim this page

    Report this page

ENDPOINTS