Logo
Zoom Public API Documentation

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

 

Body PARAM

Curl
curl -X GET 'https://api.zoom.us/v2/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?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' -H 'Accept: application/json'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS

    Key Datatype Required Description  
    type
    		 string (Required) The device status: `assigned` or `unassigned` to list device status in Zoom account. 
    assignee_type
    		 string The 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_source
    		 string The device source. `hotDesking` is only available when `type = assigned`. 
    location_status
    		 string The status of device location. It's available if `type = assigned`. 
    site_id
    		 string The site of the assignee. 
    device_type
    		 string The manufacturer name or device type. 
    keyword
    		 string The user, extension, MAC address, or IP address to filter the results.