Zoom Public API Documentation
Get webinar participant reports
GET {{baseUrl}}/report/webinars/:webinarId/participants?page_size=30&next_page_token=<string>&include_fields=registrant_id
Get a detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months. Prerequisites:
* A Pro or a higher plan with Webinar add-on enabled. Scopes: Rate Limit Label: report:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
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. | |
include_fields
|
string | The additional query parameters to include. * `registrant_id` - Include the registrant's ID in the API response. The registrant ID is the webinar participant's unique ID. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": 30,
"total_records": "<integer>",
"participants": [
{
"customer_key": "<string>",
"duration": "<integer>",
"failover": "<boolean>",
"id": "<string>",
"join_time": "<dateTime>",
"leave_time": "<dateTime>",
"name": "<string>",
"registrant_id": "<string>",
"status": "in_waiting_room",
"user_email": "pa2SVS.sWdoVD.Z$.QP%b.E/krc/p}yl@aGBRv.rta",
"user_id": "<string>",
"participant_user_id": "<string>"
},
{
"customer_key": "<string>",
"duration": "<integer>",
"failover": "<boolean>",
"id": "<string>",
"join_time": "<dateTime>",
"leave_time": "<dateTime>",
"name": "<string>",
"registrant_id": "<string>",
"status": "in_waiting_room",
"user_email": "JA87FIm.iMR|i.CVTsc{i.G}Fa`.^@RSAgC6ozL.4.-HOafM.3cFNJWUcPJR.xYgpOpmpzcx.fZ3.Qtsl1nuuUn.FA61y.Ql",
"user_id": "<string>",
"participant_user_id": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/report/webinars/:webinarId/participants?page_size=30&next_page_token=<string>&include_fields=registrant_id?page_size=30&next_page_token=<string>&include_fields=registrant_id' -H 'Accept: application/json'
ENDPOINTS