List users in a directory by site

GET {{baseUrl}}/phone/sites/:siteId/dial_by_name_directory/extensions?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&in_directory=false&site_id=fefeqd

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

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 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_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":"lfei3g","page_size":30,"result":[{"extension_id":"feq3g","display_name":"Name","email":"example@example.com","extension_number":"1003","site":{"id":"fdjl23","name":"New site"}},{"extension_id":"feq3g","display_name":"Name","email":"example@example.com","extension_number":"1003","site":{"id":"fdjl23","name":"New site"}}]}