List phone numbers

GET {{baseUrl}}/phone/numbers?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&type=all&extension_type=user&page_size=30&number_type=toll&pending_numbers=false&site_id=8f71O6rWT8KFUGQmJIFAdQ

Use this API to list all Zoom Phone numbers in a Zoom account.

Scopes: phone:read:admin
Rate Limit Label: Medium

Prerequisites: * A Pro or higher account plan * A Zoom Phone license

Request Params

KeyDatatypeRequiredDescription
next_page_tokenstringThe 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.
typestringQuery response by number assignment. The value can be one of the following:
<br>
assigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. <br>unassigned: The number is not assigned to anyone.<br>
all: Include both assigned and unassigned numbers in the response.<br>
byoc: Include Bring Your Own Carrier (BYOC) numbers only in the response.
extension_typestringThe type of assignee to whom the number is assigned. The value can be one of the following:<br>
user<br> callQueue<br> autoReceptionist<br>
commonAreaPhone
page_sizenumberThe number of records returned within a single API call.
number_typestringThe type of phone number. The value can be either toll or tollfree.
pending_numbersbooleanInclude or exclude pending numbers in the response. The value can be either true or false.
site_idstringUnique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See Managing multiple sites or Adding a site for details.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;bkOcmnm6mn6ioYAi10BcgRiEL38WzAo6jP2&quot;,&quot;page_size&quot;:30,&quot;phone_numbers&quot;:[{&quot;assignee&quot;:{&quot;extension_number&quot;:47317542,&quot;id&quot;:&quot;Y40mS72DRamFgGh0V1Ul_Q&quot;,&quot;name&quot;:&quot;User Name&quot;,&quot;type&quot;:&quot;user&quot;},&quot;capability&quot;:[&quot;incoming&quot;,&quot;incoming&quot;],&quot;carrier&quot;:{&quot;code&quot;:1,&quot;name&quot;:&quot;Bandwidth&quot;},&quot;display_name&quot;:&quot;abc&quot;,&quot;emergency_address&quot;:{&quot;address_line1&quot;:&quot;55 ALMADEN BLVD&quot;,&quot;address_line2&quot;:&quot;test 7&quot;,&quot;city&quot;:&quot;SAN JOSE&quot;,&quot;country&quot;:&quot;US&quot;,&quot;state_code&quot;:&quot;CA&quot;,&quot;zip&quot;:&quot;95113&quot;},&quot;emergency_address_status&quot;:1,&quot;emergency_address_update_time&quot;:&quot;2022-02-18T07:20:19Z&quot;,&quot;id&quot;:&quot;aMy7P9DMS9iNRkpwXNfRbw&quot;,&quot;location&quot;:&quot;United States&quot;,&quot;number&quot;:&quot;+12008001005&quot;,&quot;number_type&quot;:&quot;toll&quot;,&quot;sip_group&quot;:{&quot;display_name&quot;:&quot;RRRR&quot;,&quot;id&quot;:&quot;8MhK7ea4Q4ihIQ4TD_g0kw&quot;},&quot;site&quot;:{&quot;id&quot;:&quot;8f71O6rWT8KFUGQmJIFAdQ&quot;,&quot;name&quot;:&quot;Main Site&quot;},&quot;source&quot;:&quot;external&quot;,&quot;status&quot;:&quot;available&quot;},{&quot;assignee&quot;:{&quot;extension_number&quot;:-27970745,&quot;id&quot;:&quot;Y40mS72DRamFgGh0V1Ul_Q&quot;,&quot;name&quot;:&quot;User Name&quot;,&quot;type&quot;:&quot;user&quot;},&quot;capability&quot;:[&quot;incoming&quot;,&quot;incoming&quot;],&quot;carrier&quot;:{&quot;code&quot;:1,&quot;name&quot;:&quot;Bandwidth&quot;},&quot;display_name&quot;:&quot;abc&quot;,&quot;emergency_address&quot;:{&quot;address_line1&quot;:&quot;55 ALMADEN BLVD&quot;,&quot;address_line2&quot;:&quot;test 7&quot;,&quot;city&quot;:&quot;SAN JOSE&quot;,&quot;country&quot;:&quot;US&quot;,&quot;state_code&quot;:&quot;CA&quot;,&quot;zip&quot;:&quot;95113&quot;},&quot;emergency_address_status&quot;:1,&quot;emergency_address_update_time&quot;:&quot;2022-02-18T07:20:19Z&quot;,&quot;id&quot;:&quot;aMy7P9DMS9iNRkpwXNfRbw&quot;,&quot;location&quot;:&quot;United States&quot;,&quot;number&quot;:&quot;+12008001005&quot;,&quot;number_type&quot;:&quot;toll&quot;,&quot;sip_group&quot;:{&quot;display_name&quot;:&quot;RRRR&quot;,&quot;id&quot;:&quot;8MhK7ea4Q4ihIQ4TD_g0kw&quot;},&quot;site&quot;:{&quot;id&quot;:&quot;8f71O6rWT8KFUGQmJIFAdQ&quot;,&quot;name&quot;:&quot;Main Site&quot;},&quot;source&quot;:&quot;external&quot;,&quot;status&quot;:&quot;available&quot;}],&quot;total_records&quot;:50}