Zoom Public API Documentation
Get webinar sharing/recording details
GET {{baseUrl}}/metrics/webinars/:webinarId/participants/sharing?type=live&page_size=30&next_page_token=<string>
Retrieve the sharing and recording details of participants from live or past webinars. Prerequisites: Scopes: Rate Limit Label:
dashboard_webinars:read:admin,dashboard:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The type of webinar to query: * `past` — All past webinars. * `live` - All live webinars. This value defaults to `live`. | |
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 exceed the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": 30,
"total_records": "<integer>",
"participants": [
{
"details": [
{
"content": "<string>",
"end_time": "<string>",
"start_time": "<string>"
},
{
"content": "<string>",
"end_time": "<string>",
"start_time": "<string>"
}
],
"id": "<string>",
"user_id": "<string>",
"user_name": "<string>"
},
{
"details": [
{
"content": "<string>",
"end_time": "<string>",
"start_time": "<string>"
},
{
"content": "<string>",
"end_time": "<string>",
"start_time": "<string>"
}
],
"id": "<string>",
"user_id": "<string>",
"user_name": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/sharing?type=live&page_size=30&next_page_token=<string>?type=live&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS