List meeting participants
GET {{baseUrl}}/metrics/meetings/:meetingId/participants?type=live&page_size=30&next_page_token=<string>&include_fields=registrant_id
Return a list of participants from live or past meetings.
If you don't provide the Note: This API may return empty values for participants' Prerequisites:
* A Business or higher plan. Scopes: Rate Limit Label: type query parameter, the default value is set to the live value. This API only returns 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. user_name, ip_address, location, and email responses when the account calling this API:
* Does not have a signed HIPAA business associate agreement (BAA).
* Is a legacy HIPAA BAA account.
* Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details. dashboard_meetings:read:admin,dashboard:read:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The type of meeting to query. * `past` - All past meetings. * `pastOne` - All past one-user meetings. * `live` - All live meetings. This value defaults to `live`. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
include_fields
|
string | This field provides `registrant_id` as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a [meeting registrant](/docs/api-reference/zoom-api/methods#operation/meetingRegistrants), which is not supported for `live` meeting types. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": 30,
"total_records": "<integer>",
"participants": [
{
"audio_quality": "good",
"camera": "<string>",
"connection_type": "<string>",
"customer_key": "<string>",
"data_center": "<string>",
"device": "Mac",
"domain": "<string>",
"email": "<email>",
"from_sip_uri": "<string>",
"full_data_center": "<string>",
"harddisk_id": "<string>",
"id": "<string>",
"in_room_participants": "<integer>",
"internal_ip_addresses": [
"<string>",
"<string>"
],
"ip_address": "<string>",
"join_time": "<dateTime>",
"leave_reason": "Host ended the meeting.",
"leave_time": "<dateTime>",
"location": "<string>",
"mac_addr": "<string>",
"microphone": "<string>",
"network_type": "Wifi",
"participant_user_id": "<string>",
"pc_name": "<string>",
"recording": "<boolean>",
"registrant_id": "<string>",
"role": "attendee",
"screen_share_quality": "fair",
"share_application": "<boolean>",
"share_desktop": "<boolean>",
"share_whiteboard": "<boolean>",
"sip_uri": "<string>",
"speaker": "<string>",
"status": "in_meeting",
"user_id": "<string>",
"user_name": "<string>",
"version": "<string>",
"video_quality": "fair",
"bo_mtg_id": "<string>",
"audio_call": [
{
"call_number": "<string>",
"call_type": "call-in",
"zoom_number": "<string>"
},
{
"call_number": "<string>",
"call_type": "call-out",
"zoom_number": "<string>"
}
],
"os": "<string>",
"os_version": "<string>",
"device_name": "<string>"
},
{
"audio_quality": "",
"camera": "<string>",
"connection_type": "<string>",
"customer_key": "<string>",
"data_center": "<string>",
"device": "H.323/SIP",
"domain": "<string>",
"email": "<email>",
"from_sip_uri": "<string>",
"full_data_center": "<string>",
"harddisk_id": "<string>",
"id": "<string>",
"in_room_participants": "<integer>",
"internal_ip_addresses": [
"<string>",
"<string>"
],
"ip_address": "<string>",
"join_time": "<dateTime>",
"leave_reason": "$name left the meeting.",
"leave_time": "<dateTime>",
"location": "<string>",
"mac_addr": "<string>",
"microphone": "<string>",
"network_type": "Wired",
"participant_user_id": "<string>",
"pc_name": "<string>",
"recording": "<boolean>",
"registrant_id": "<string>",
"role": "attendee",
"screen_share_quality": "poor",
"share_application": "<boolean>",
"share_desktop": "<boolean>",
"share_whiteboard": "<boolean>",
"sip_uri": "<string>",
"speaker": "<string>",
"status": "in_meeting",
"user_id": "<string>",
"user_name": "<string>",
"version": "<string>",
"video_quality": "poor",
"bo_mtg_id": "<string>",
"audio_call": [
{
"call_number": "<string>",
"call_type": "call-out",
"zoom_number": "<string>"
},
{
"call_number": "<string>",
"call_type": "call-in",
"zoom_number": "<string>"
}
],
"os": "<string>",
"os_version": "<string>",
"device_name": "<string>"
}
]
} |
ENDPOINTS