List phone users
GET {{baseUrl}}/phone/users?page_size=30&next_page_token=<string>&site_id=<string>&calling_type=<integer>&status=pending&department=<string>&cost_center=<string>&keyword=<string>
Returns a list of all of an account's users who are assigned a Zoom Phone license.
Prerequisites: * A Pro or higher account plan * A Zoom Phone license
Scopes: phone:read:admin
Granular Scopes: phone:read:list_users:admin
Rate Limit Label: LIGHT
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | number | The number of records returned from a single API call. | |
next_page_token | string | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
site_id | string | The unique identifier of the site. Get it from the List Phone Sites API. | |
calling_type | string | The type of calling plan. | |
status | string | The status of the Zoom Phone user. |
pending: The users have been assigned the Zoom One license, but not been assigned Zoom Phone feature. |
| department | string | | The department where the user belongs. |
| cost_center | string | | The cost center where the user belongs. |
| keyword | string | | The partial string of user's name, extension number, or phone number. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","users":[{"calling_plans":[{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"email":"\u003cemail\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","phone_user_id":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"status":"\u003cstring\u003e","phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"department":"\u003cstring\u003e","cost_center":"\u003cstring\u003e"},{"calling_plans":[{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"email":"\u003cemail\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","phone_user_id":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"status":"\u003cstring\u003e","phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"department":"\u003cstring\u003e","cost_center":"\u003cstring\u003e"}]}