List Zoom Rooms
GET {{baseUrl}}/rooms?status=UnderConstruction&tag_ids=<string>&type=ZoomRoom&unassigned_rooms=false&page_size=30&next_page_token=<string>&location_id=<string>&query_name=<string>
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing Zoom Rooms in a Zoom account.
Prerequisites:
-
Pro or a higher plan with
Zoom Room
license.
Scopes:
room:read:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| status | string | | The status of the Zoom Room. |
| tag_ids | string | | The room tag IDs associated with the Zoom Room. Use commas (,) to separate between them. It's OR logic if query for multiple tags. |
| type | string | | The type of Zoom Rooms . |
| unassigned_rooms | boolean | | Use this query parameter with a value of true if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet. |
| 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 exceeds the current page size. This token's expiration period is 15 minutes. |
| location_id | string | | The parent location ID of the Zoom Room. |
| query_name | string | | The name of a Zoom Room. If you do not call this parameter, the API will return all of the account's Zoom Rooms. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","rooms":[{"activation_code":"\u003cstring\u003e","id":"\u003cstring\u003e","location_id":"\u003cstring\u003e","name":"\u003cstring\u003e","room_id":"\u003cstring\u003e","status":"Offline","tag_ids":["\u003cstring\u003e","\u003cstring\u003e"]},{"activation_code":"\u003cstring\u003e","id":"\u003cstring\u003e","location_id":"\u003cstring\u003e","name":"\u003cstring\u003e","room_id":"\u003cstring\u003e","status":"Available","tag_ids":["\u003cstring\u003e","\u003cstring\u003e"]}]}