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:
phone:read:admin
Granular Scopes:
phone:read:directory:admin
Rate Limit Label
:
Medium
Request Params
| 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 to which users to get belongs. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","result":[{"extension_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","email":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"extension_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","email":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}]}