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

KeyDatatypeRequiredDescription
statusstringThe status of the Zoom Room.
tag_idsstringThe room tag IDs associated with the Zoom Room. Use commas (,) to separate between them. It's OR logic if query for multiple tags.
typestringThe type of Zoom Rooms .
unassigned_roomsbooleanUse 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_sizenumberThe number of records returned within a single API call.
next_page_tokenstringUse 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_idstringThe parent location ID of the Zoom Room.
query_namestringThe name of a Zoom Room. If you do not call this parameter, the API will return all of the account's Zoom Rooms.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;rooms&quot;:[{&quot;activation_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;room_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;Offline&quot;,&quot;tag_ids&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},{&quot;activation_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;location_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;room_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;Available&quot;,&quot;tag_ids&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}]}