Zoom Public API Documentation
List Zoom Room locations
GET {{baseUrl}}/rooms/locations?parent_location_id=<string>&type=<string>&page_size=30&next_page_token=<string>
A Zoom account owner or a Zoom Room administrator can establish a location hierarchy to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account. Prerequisites:
* Account owner or admin permissions.
* Zoom Rooms Version 4.0 or higher Scopes: Rate Limit Label: room:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
parent_location_id
|
string | A unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level. | |
type
|
string | Use this field to filter the response by the type of location. The value can be one of the following: `country`, `states`, `city`, `campus`, `building`, `floor`. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"locations": [
{
"id": "<string>",
"name": "<string>",
"parent_location_id": "<string>",
"type": "states"
},
{
"id": "<string>",
"name": "<string>",
"parent_location_id": "<string>",
"type": "states"
}
],
"next_page_token": "<string>",
"page_size": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/rooms/locations?parent_location_id=<string>&type=<string>&page_size=30&next_page_token=<string>?parent_location_id=<string>&type=<string>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS