Logo
Zoom Public API Documentation

Get a list of monitoring groups on an account

GET {{baseUrl}}/phone/monitoring_groups?type=2&site_id=<string>&page_size=<integer>&next_page_token=<string>

Returns an account's monitoring group list.

Prerequisites: * A Business or Enterprise account * A Zoom Phone license

Scopes: phone:read:admin

Granular Scopes: phone:read:list_monitoring_groups:admin

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description 
type
number The monitoring group's type.
site_id
string The unique identifier of the monitoring group's site.
page_size
string The size of the page.
next_page_token
string The current page number of returned records.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "monitoring_groups": [ { "id": "<string>", "monitor_members_count": "<integer>", "monitored_members_count": "<integer>", "monitoring_privileges": [ "listen", "listen" ], "name": "<string>", "prompt": "<boolean>", "site": { "id": "<string>", "name": "<string>" }, "type": 4 }, { "id": "<string>", "monitor_members_count": "<integer>", "monitored_members_count": "<integer>", "monitoring_privileges": [ "barge", "take_over" ], "name": "<string>", "prompt": "<boolean>", "site": { "id": "<string>", "name": "<string>" }, "type": 4 } ], "next_page_token": "<string>", "page_size": "<integer>", "total_records": "<integer>" }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/monitoring_groups?type=2&site_id=<string>&page_size=<integer>&next_page_token=<string>?type=2&site_id=<string>&page_size=<integer>&next_page_token=<string>' -H 'Accept: application/json'

ENDPOINTS