Zoom Public API Documentation
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: Scopes: Rate Limit Label:
room:read:adminMEDIUM
Body
PARAM
| 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": "<string>",
"page_size": "<integer>",
"rooms": [
{
"activation_code": "<string>",
"id": "<string>",
"location_id": "<string>",
"name": "<string>",
"room_id": "<string>",
"status": "Offline",
"tag_ids": [
"<string>",
"<string>"
]
},
{
"activation_code": "<string>",
"id": "<string>",
"location_id": "<string>",
"name": "<string>",
"room_id": "<string>",
"status": "Available",
"tag_ids": [
"<string>",
"<string>"
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/rooms?status=UnderConstruction&tag_ids=<string>&type=ZoomRoom&unassigned_rooms=false&page_size=30&next_page_token=<string>&location_id=<string>&query_name=<string>?status=UnderConstruction&tag_ids=<string>&type=ZoomRoom&unassigned_rooms=false&page_size=30&next_page_token=<string>&location_id=<string>&query_name=<string>' -H 'Accept: application/json'
ENDPOINTS