Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
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
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

/metrics/meetings/{meetingId}/participants

Use this API to return 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 the live value. This API will only return metrics for participants in a live meeting, if any exist. 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.

Note:

This API may return empty values for participants’ user_name, ip_address, location, and email responses when the account calling this API:

Scopes: dashboard_meetings:read:admin
Rate Limit Label: Heavy

Prerequisites:

  • A Business or 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]

Information about the meeting participants. If a participant left a meeting and rejoined the same meeting, their information will appear as many times as they joined the meeting.

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