Logo
Zoom Public API Documentation

List users in directory

GET {{baseUrl}}/phone/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.

Prerequisites: * Business or Education account * Zoom Phone license

Scopes: phone:read:admin

Granular Scopes: phone:read:directory: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.
in_directory
boolean Whether the user belongs to the directory.
site_id
string (Required) Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites).



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

Curl
curl -X GET 'https://api.zoom.us/v2/phone/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