List Zoom Rooms

GET {{baseUrl}}/metrics/zoomrooms?page_size=30&page_number=1&next_page_token=<string>

List information on all Zoom Rooms in an account.

Prerequisites:

  • Business, Education or API Plan with Zoom Rooms set up.

Scopes: dashboard_zr:read:admin,dashboard:read:admin

Rate Limit Label: Resource-intensive

Request Params

KeyDatatypeRequiredDescription
page_sizenumberThe number of records returned within a single API call.
page_numbernumberThe page number of the current page in the returned records.
next_page_tokenstringThe 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.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_count&quot;:&quot;\u003cinteger\u003e&quot;,&quot;page_number&quot;:1,&quot;page_size&quot;:30,&quot;total_records&quot;:&quot;\u003cinteger\u003e&quot;,&quot;zoom_rooms&quot;:[{&quot;account_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;calender_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;camera&quot;:&quot;\u003cstring\u003e&quot;,&quot;device_ip&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;health&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;issues&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;last_start_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;microphone&quot;:&quot;\u003cstring\u003e&quot;,&quot;room_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;speaker&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;},{&quot;account_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;calender_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;camera&quot;:&quot;\u003cstring\u003e&quot;,&quot;device_ip&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;health&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;issues&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;last_start_time&quot;:&quot;\u003cstring\u003e&quot;,&quot;location&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;microphone&quot;:&quot;\u003cstring\u003e&quot;,&quot;room_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;speaker&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}]}