Logo
Zoom Public API Documentation

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

 

Body PARAM

Key Datatype Required Description 
page_size
number The number of records returned within a single API call.
page_number
number The page number of the current page in the returned records.
next_page_token
string 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.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_count": "<integer>", "page_number": 1, "page_size": 30, "total_records": "<integer>", "zoom_rooms": [ { "account_type": "<string>", "calender_name": "<string>", "camera": "<string>", "device_ip": "<string>", "email": "<string>", "health": "<string>", "id": "<string>", "issues": [ "<string>", "<string>" ], "last_start_time": "<string>", "location": "<string>", "location_id": "<string>", "microphone": "<string>", "room_name": "<string>", "speaker": "<string>", "status": "<string>" }, { "account_type": "<string>", "calender_name": "<string>", "camera": "<string>", "device_ip": "<string>", "email": "<string>", "health": "<string>", "id": "<string>", "issues": [ "<string>", "<string>" ], "last_start_time": "<string>", "location": "<string>", "location_id": "<string>", "microphone": "<string>", "room_name": "<string>", "speaker": "<string>", "status": "<string>" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/metrics/zoomrooms?page_size=30&page_number=1&next_page_token=<string>?page_size=30&page_number=1&next_page_token=<string>' -H 'Accept: application/json'

ENDPOINTS