Logo
Zoom Public API Documentation

List phone sites

GET {{baseUrl}}/phone/sites?page_size=30&next_page_token=<string>

Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the sites that have been created for an account.

Prerequisites:

  • Multiple Sites must be enabled.
  • Pro or a higher account with Zoom Phone enabled.

Scopes: phone:read:admin

Granular Scopes: phone:read:list_sites:admin

Rate Limit Label: Medium

 

Body PARAM

Key Datatype Required Description 
page_size
number The number of records returned within a single API call.
next_page_token
string The next page token paginates through a large set of results. A next page token is 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_size": "<integer>", "sites": [ { "country": { "code": "<string>", "name": "<string>" }, "id": "<string>", "main_auto_receptionist": { "extension_id": "<string>", "extension_number": "<long>", "id": "<string>", "name": "<string>" }, "name": "<string>", "site_code": "<integer>" }, { "country": { "code": "<string>", "name": "<string>" }, "id": "<string>", "main_auto_receptionist": { "extension_id": "<string>", "extension_number": "<long>", "id": "<string>", "name": "<string>" }, "name": "<string>", "site_code": "<integer>" } ], "total_records": "<integer>" }



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

ENDPOINTS