Back to ZoomList Webinar Participants
Use this API to list all the participants who attended a webinar hosted in the past.
Scopes: webinar:read:admin
, webinar:read
Rate Limit Label: Medium
Prerequisites:
- A Pro or higher plan with a Webinar add-on.
Input
type: object
properties:
parameters:
type: object
properties:
webinarId:
type: string
example: '95204914252'
description: >-
The webinar's ID. To get this value, use the [**List
webinars**](/docs/api-reference/zoom-api/methods#operation/webinars)
API.
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.
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 this request.
type: integer
example: 1
page_size:
default: 30
description: The total number of records returned from a single API call.
maximum: 300
type: integer
example: 30
participants:
type: array
items:
type: object
properties:
id:
description: Unique identifier of the participant.
type: string
example: 30R7kT7bTIKSNUFEuH_Qlg
name:
description: Name of the participant.
type: string
example: Jill Chill
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
registrant_id:
description: >-
The participant's unique registrant ID. This field only returns if
you pass the `registrant_id` value for the `include_fields` query
parameter.
This field does not return if the `type` query parameter is the
`live` value.
type: string
example: _f08HhPJS82MIVLuuFaJPg
user_email:
description: >-
Email address of the participant. 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.
format: email
type: string
example:
[email protected]
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 leave time.
example: '2019-02-01T12:54:12.660Z'
duration:
type: integer
description: The participant's attendance duration.
example: 20
failover:
type: boolean
description: Whether failover occurred during the webinar.
example: false
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
total_records:
description: The total number of records available across all pages.
type: integer
example: 1