Zoom Public API Documentation
List phone users
GET {{baseUrl}}/phone/users?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&site_id=8f71O6rWT8KFUGQmJIFAdQ
Use this API to return a list of all of an account's users who are assigned a Zoom Phone license. Scopes: Prerequisites:
* A Pro or higher account plan
* A Zoom Phone licensephone:read:admin
Rate Limit Label: Light
Body
PARAM
| 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 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. | |
site_id
|
string | Unique identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "nav48KOj42vYPSG4f0cCdT575bZ980did22",
"page_size": 30,
"total_records": 45,
"users": [
{
"calling_plans": [
{
"name": "US/CA Metered Calling Plan",
"type": 100
},
{
"name": "US/CA Metered Calling Plan",
"type": 100
}
],
"email": "202007160003@testapi.com",
"extension_id": "V4UobpuxRxCwN_8iNf7k4w",
"extension_number": -79894737,
"id": "w0RChiauQeqRlv5fgxYULQ",
"name": "APITA AUTO",
"phone_user_id": "BOSr0vUiTl61WLR-Q_7bUw",
"site": {
"id": "IjJ2D75SQJit1VdDvkK_mQ",
"name": "ApiTA_Site_2020_07_12_02_33_45_707"
},
"status": "activate"
},
{
"calling_plans": [
{
"name": "US/CA Metered Calling Plan",
"type": 100
},
{
"name": "US/CA Metered Calling Plan",
"type": 100
}
],
"email": "202007160003@testapi.com",
"extension_id": "V4UobpuxRxCwN_8iNf7k4w",
"extension_number": 68730199,
"id": "w0RChiauQeqRlv5fgxYULQ",
"name": "APITA AUTO",
"phone_user_id": "BOSr0vUiTl61WLR-Q_7bUw",
"site": {
"id": "IjJ2D75SQJit1VdDvkK_mQ",
"name": "ApiTA_Site_2020_07_12_02_33_45_707"
},
"status": "activate"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&site_id=8f71O6rWT8KFUGQmJIFAdQ?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&site_id=8f71O6rWT8KFUGQmJIFAdQ' -H 'Accept: application/json'
ENDPOINTS