Logo
Zoom Public API Documentation

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

 

Body PARAM

Curl
curl -X GET 'https://api.zoom.us/v2/phone/users?page_size=30&next_page_token=<string>&site_id=<string>&calling_type=<integer>&status=pending&department=<string>&cost_center=<string>&keyword=<string>?page_size=30&next_page_token=<string>&site_id=<string>&calling_type=<integer>&status=pending&department=<string>&cost_center=<string>&keyword=<string>' -H 'Accept: application/json'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS

    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](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. 
    calling_type
    		 string The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) 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.