List devices

GET {{baseUrl}}/phone/devices?type=assigned&assignee_type=commonArea&device_source=haas&location_status=unknownAddress&site_id=<string>&device_type=yealink&keyword=<string>&next_page_token=<string>&page_size=30

Lists all the desk phone devices that are configured with Zoom Phone on an account.

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions

Scopes: phone:read:admin

Granular Scopes: phone:read:list_devices:admin

Rate Limit Label: MEDIUM

Request Params

KeyDatatypeRequiredDescription
typestring(Required) The device status: assigned or unassigned to list device status in Zoom account.
assignee_typestringThe type of the assignee. It's available if type = assigned. It's unavailable if the account has not enabled the common area feature. It also returns devices of the specified assignee_type. If unspecified, it returns all assigned devices.
device_sourcestringThe device source. hotDesking is only available when type = assigned.
location_statusstringThe status of device location. It's available if type = assigned.
site_idstringThe site of the assignee.
device_typestringThe manufacturer name or device type.
keywordstringThe user, extension, MAC address, or IP address to filter the results.
next_page_tokenstringThe 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.
page_sizenumberThe number of records returned within a single API call.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;devices&quot;:[{&quot;assignee&quot;:{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_type&quot;:&quot;user&quot;},&quot;assignees&quot;:[{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_type&quot;:&quot;user&quot;,&quot;extension_id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_type&quot;:&quot;commonArea&quot;,&quot;extension_id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;device_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;mac_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;site&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},&quot;status&quot;:&quot;offline&quot;,&quot;provision_template_id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;assignee&quot;:{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_type&quot;:&quot;commonArea&quot;},&quot;assignees&quot;:[{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_type&quot;:&quot;user&quot;,&quot;extension_id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;extension_number&quot;:&quot;\u003clong\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_type&quot;:&quot;user&quot;,&quot;extension_id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;device_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;mac_address&quot;:&quot;\u003cstring\u003e&quot;,&quot;site&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},&quot;status&quot;:&quot;offline&quot;,&quot;provision_template_id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;total_records&quot;:&quot;\u003cinteger\u003e&quot;}