List users in directory

GET {{baseUrl}}/phone/dial_by_name_directory/extensions?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&in_directory=false&site_id=LFD8Bb63f

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

Rate Limit Label: Medium

Request Params

KeyDatatypeRequiredDescription
page_sizenumberThe number of records returned within a single API call.
next_page_tokenstringThe next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
in_directorybooleanWhether the user belongs to the directory.
site_idstringUnique identifier of the site.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"next_page_token":"FHBv62","page_size":10,"result":[{"extension_id":"FDFU83j","display_name":"CUSTOMERS","email":"email@example.com","extension_number":"1933","site":{"id":"flej2f","name":"New Site"}},{"extension_id":"FDFU83j","display_name":"CUSTOMERS","email":"email@example.com","extension_number":"1933","site":{"id":"flej2f","name":"New Site"}}]}