Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
get

/metrics/meetings/{meetingId}/participants

Get a list of participants from live or past meetings.

If you do not provide the type query parameter, the default value will be set to live and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for type.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.

Scopes: dashboard_meetings:read:admin
Rate Limit Label: Heavy
Prerequisites: Business or a higher plan.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
4 Query Parameters

Responses

HTTP Status Code: 200
Meeting participants returned.
Only available for paid accounts that have enabled the dashboard feature.

1 Example
Schema
object

Pagination object.

page_count
integer

The number of pages returned for the request made.

page_size
integer

The number of records returned within a single API call.

2 validations
total_records
integer

The number of all records available across pages.

next_page_token
string

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.

participants
array[object]

Array of participant session objects. If a participant left a meeting and rejoined the same meeting, their information will appear multiple times (as many times as they joined the meeting).

Note:

  • If the account calling this API is a business associate (BAA) under HIPAA, this array returns an empty string value for the user_name, ip_address, location, and email responses.
  • The API only returns the audio_quality, video_quality, and share_screen_quality fields when the Meeting quality scores and network alerts on Dashboard setting is enabled in the Zoom Web Portal and the Show meeting quality score and network alerts on Dashboard option is selected in Account Settings.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
meetingId
$$.env
1 variable not set
oauth_access_token