Logo
Zoom Public API Documentation

Get meeting participant reports

GET {{baseUrl}}/report/meetings/:meetingId/participants?page_size=30&next_page_token=<string>&include_fields=registrant_id

Return a report of a past meeting with two or more participants, including the host. To return a report for past meeting with only one participant, use the List meeting participants API.

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.

Prerequisites: * A Pro or a higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

 

Body PARAM

Key Datatype Required Description 
page_size
number The number of records returned within a single API call.
next_page_token
string 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.
include_fields
string Provide `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).



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_count": "<integer>", "page_size": 30, "total_records": "<integer>", "participants": [ { "customer_key": "<string>", "duration": "<integer>", "failover": "<boolean>", "id": "<string>", "join_time": "<dateTime>", "leave_time": "<dateTime>", "name": "<string>", "registrant_id": "<string>", "status": "in_waiting_room", "user_email": "<string>", "user_id": "<string>", "bo_mtg_id": "<string>", "participant_user_id": "<string>" }, { "customer_key": "<string>", "duration": "<integer>", "failover": "<boolean>", "id": "<string>", "join_time": "<dateTime>", "leave_time": "<dateTime>", "name": "<string>", "registrant_id": "<string>", "status": "in_waiting_room", "user_email": "<string>", "user_id": "<string>", "bo_mtg_id": "<string>", "participant_user_id": "<string>" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/report/meetings/:meetingId/participants?page_size=30&next_page_token=<string>&include_fields=registrant_id?page_size=30&next_page_token=<string>&include_fields=registrant_id' -H 'Accept: application/json'

ENDPOINTS