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

KeyDatatypeRequiredDescription
page_sizenumberThe number of records returned within a single API call.
next_page_tokenstringThe 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_directorybooleanWhether the user belongs to the directory.
site_idstringUnique identifier of the site to which users to get belongs.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;result&quot;:[{&quot;extension_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;site&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;extension_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;site&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;}}]}