Back to ZoomGet Webinar Participant Reports
Use this API to get a detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months.
Scopes: report:read:admin
Rate Limit Label: Heavy
Prerequisites:
- A Pro or a higher plan with Webinar add-on enabled.
Input
type: object
properties:
parameters:
type: object
properties:
webinarId:
type: string
example: ABCDE12345
description: >-
The webinar's ID or universally unique ID (UUID).
* If you provide a webinar ID, the API will return a response for the
latest webinar instance.
* If you provide a webinar UUID that begins with a `/` character or
contains the `//` characters, you **must** [double
encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)
the webinar UUID before making an API request.
page_size:
default: 30
maximum: 300
type: integer
example: 30
description: The number of records returned within a single API call.
next_page_token:
type: string
example: IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2
description: >-
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:
enum:
- registrant_id
type: string
example: registrant_id
description: >-
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.
required:
- webinarId
title: Parameters
Output
type: object
properties:
next_page_token:
description: >-
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.
type: string
example: Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3
page_count:
description: The number of pages returned for the request made.
type: integer
example: 1
page_size:
default: 30
description: The number of records returned within a single API call.
maximum: 300
type: integer
example: 30
total_records:
description: The number of all records available across pages.
type: integer
example: 1
participants:
type: array
description: Information about the webinar participant.
items:
type: object
properties:
customer_key:
type: string
maxLength: 15
description: >-
The participant's SDK identifier. This value can be alphanumeric, up
to a maximum length of 15 characters.
example: 349589LkJyeW
duration:
type: integer
description: The participant's attendance duration.
example: 20
failover:
type: boolean
description: Whether failover occurred during the webinar.
example: false
id:
type: string
description: >-
The participant's universally unique ID:
* This values is the same as the participant's user ID if the
participant joins the meeting by logging into Zoom.
* If the participant joins the meeting without logging in, the API
returns an empty string value.
example: ABCDEF123456
join_time:
type: string
format: date-time
description: The participant's join time.
example: '2019-02-01T12:34:12.660Z'
leave_time:
type: string
format: date-time
description: The participant's join time.
example: '2019-02-01T12:54:12.660Z'
name:
type: string
description: >-
The participant's display name. This returns an empty string value
if the account calling the API is a BAA account.
example: jchill
registrant_id:
type: string
description: >-
The registrant's ID. This field only returns if you provide the
`registrant_id` value for the `include_fields` query parameter.
example: 123456FEDCBA
status:
type: string
description: |-
The participant's status:
* `in_meeting` — In a meeting.
* `in_waiting_room` — In a waiting room.
enum:
- in_meeting
- in_waiting_room
example: in_meeting
user_email:
type: string
format: email
description: >-
The participant's email address. If the participant is **not** part
of the host's account, this returns an empty string value, with some
exceptions. See [Email address display
rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address)
for details. This returns an empty string value if the account
calling the API is a BAA account.
example:
[email protected]
user_id:
type: string
description: >-
The participant's ID. This ID is assigned to the participant upon
joining the webinar and is only valid for that webinar.
example: ABCDEF123456