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
Request Params
| 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. |
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":[{"customer_key":"\u003cstring\u003e","duration":"\u003cinteger\u003e","failover":"\u003cboolean\u003e","id":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_time":"\u003cdateTime\u003e","name":"\u003cstring\u003e","registrant_id":"\u003cstring\u003e","status":"in_waiting_room","user_email":"\u003cstring\u003e","user_id":"\u003cstring\u003e","bo_mtg_id":"\u003cstring\u003e","participant_user_id":"\u003cstring\u003e"},{"customer_key":"\u003cstring\u003e","duration":"\u003cinteger\u003e","failover":"\u003cboolean\u003e","id":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_time":"\u003cdateTime\u003e","name":"\u003cstring\u003e","registrant_id":"\u003cstring\u003e","status":"in_waiting_room","user_email":"\u003cstring\u003e","user_id":"\u003cstring\u003e","bo_mtg_id":"\u003cstring\u003e","participant_user_id":"\u003cstring\u003e"}]}