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
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.
Note:
This API may return empty values for participants'
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.
Prerequisites:
- A Business or higher plan.
Scopes:
dashboard_meetings:read:admin
,
dashboard:read:admin
Rate Limit Label
:
HEAVY
Request Params
| 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, which is not supported for live meeting types. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":30,"total_records":"\u003cinteger\u003e","participants":[{"audio_quality":"good","camera":"\u003cstring\u003e","connection_type":"\u003cstring\u003e","customer_key":"\u003cstring\u003e","data_center":"\u003cstring\u003e","device":"Mac","domain":"\u003cstring\u003e","email":"\u003cemail\u003e","from_sip_uri":"\u003cstring\u003e","full_data_center":"\u003cstring\u003e","harddisk_id":"\u003cstring\u003e","id":"\u003cstring\u003e","in_room_participants":"\u003cinteger\u003e","internal_ip_addresses":["\u003cstring\u003e","\u003cstring\u003e"],"ip_address":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_reason":"Host ended the meeting.","leave_time":"\u003cdateTime\u003e","location":"\u003cstring\u003e","mac_addr":"\u003cstring\u003e","microphone":"\u003cstring\u003e","network_type":"Wifi","participant_user_id":"\u003cstring\u003e","pc_name":"\u003cstring\u003e","recording":"\u003cboolean\u003e","registrant_id":"\u003cstring\u003e","role":"attendee","screen_share_quality":"fair","share_application":"\u003cboolean\u003e","share_desktop":"\u003cboolean\u003e","share_whiteboard":"\u003cboolean\u003e","sip_uri":"\u003cstring\u003e","speaker":"\u003cstring\u003e","status":"in_meeting","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","version":"\u003cstring\u003e","video_quality":"fair","bo_mtg_id":"\u003cstring\u003e","audio_call":[{"call_number":"\u003cstring\u003e","call_type":"call-in","zoom_number":"\u003cstring\u003e"},{"call_number":"\u003cstring\u003e","call_type":"call-out","zoom_number":"\u003cstring\u003e"}],"os":"\u003cstring\u003e","os_version":"\u003cstring\u003e","device_name":"\u003cstring\u003e"},{"audio_quality":"","camera":"\u003cstring\u003e","connection_type":"\u003cstring\u003e","customer_key":"\u003cstring\u003e","data_center":"\u003cstring\u003e","device":"H.323/SIP","domain":"\u003cstring\u003e","email":"\u003cemail\u003e","from_sip_uri":"\u003cstring\u003e","full_data_center":"\u003cstring\u003e","harddisk_id":"\u003cstring\u003e","id":"\u003cstring\u003e","in_room_participants":"\u003cinteger\u003e","internal_ip_addresses":["\u003cstring\u003e","\u003cstring\u003e"],"ip_address":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_reason":"$name left the meeting.","leave_time":"\u003cdateTime\u003e","location":"\u003cstring\u003e","mac_addr":"\u003cstring\u003e","microphone":"\u003cstring\u003e","network_type":"Wired","participant_user_id":"\u003cstring\u003e","pc_name":"\u003cstring\u003e","recording":"\u003cboolean\u003e","registrant_id":"\u003cstring\u003e","role":"attendee","screen_share_quality":"poor","share_application":"\u003cboolean\u003e","share_desktop":"\u003cboolean\u003e","share_whiteboard":"\u003cboolean\u003e","sip_uri":"\u003cstring\u003e","speaker":"\u003cstring\u003e","status":"in_meeting","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","version":"\u003cstring\u003e","video_quality":"poor","bo_mtg_id":"\u003cstring\u003e","audio_call":[{"call_number":"\u003cstring\u003e","call_type":"call-out","zoom_number":"\u003cstring\u003e"},{"call_number":"\u003cstring\u003e","call_type":"call-in","zoom_number":"\u003cstring\u003e"}],"os":"\u003cstring\u003e","os_version":"\u003cstring\u003e","device_name":"\u003cstring\u003e"}]}