Zoom Public API Documentation
List users in a directory by site
GET {{baseUrl}}/phone/sites/:siteId/dial_by_name_directory/extensions?page_size=30&next_page_token=<string>&in_directory=false&site_id=<string>
Use this API to get users that are in or not in a directory of the specified site. Prerequisites:
* Business or Education account
* Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:directory:adminMedium
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. | |
in_directory
|
boolean | Whether the user belongs to the directory. | |
site_id
|
string | Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) to which users to get belongs. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": "<integer>",
"result": [
{
"extension_id": "<string>",
"display_name": "<string>",
"email": "<string>",
"extension_number": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
}
},
{
"extension_id": "<string>",
"display_name": "<string>",
"email": "<string>",
"extension_number": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
}
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/sites/:siteId/dial_by_name_directory/extensions?page_size=30&next_page_token=<string>&in_directory=false&site_id=<string>?page_size=30&next_page_token=<string>&in_directory=false&site_id=<string>' -H 'Accept: application/json'
ENDPOINTS