GET /metrics/meetings/{meetingId}/participants
Get 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 live and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for type.
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.
Scopes: dashboard_meetings:read:admin
Rate Limit Label: Heavy
Prerequisites: Business or a higher plan.
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
meetingId |
String | Yes |
The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page_size |
Integer | No |
The number of records returned within a single API call. Default value: 30 |
type |
String | No |
The meeting types: Valid values:
Default value: "live" |
next_page_token |
String | No |
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. |
include_fields |
String | No |
Provide Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.