Zoom Public API Documentation
List devices
GET {{baseUrl}}/devices?search_text=<string>&platform_os=iphone&is_enrolled_in_zdm=true&device_type=-1&device_vendor=<string>&device_model=<string>&device_status=-1&page_size=30&next_page_token=<string>
This API lets you list devices. Scopes: Rate Limit Label: device:read:admin,device:write:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
search_text
|
string | Filter devices by name or serial number. | |
platform_os
|
string | Filter devices by platform operating system. | |
is_enrolled_in_zdm
|
boolean | Filter devices by enrollment of ZDM (Zoom Device Management). | |
device_type
|
number | Filter devices by device type. Device Type: `-1` - All Zoom Room device(0,1,2,3,4,6). `0` - Zoom Rooms Computer. `1` - Zoom Rooms Controller. `2` - Zoom Rooms Scheduling Display. `3` - Zoom Rooms Control System. `4` - Zoom Rooms Whiteboard. `5` - Zoom Phone Appliance. `6` - Zoom Rooms Computer (with Controller). | |
device_vendor
|
string | Filter devices by vendor. | |
device_model
|
string | Filter devices by model. | |
device_status
|
number | Filter devices by status. Device Status: `0` - offline. `1` - online. `-1` - unlink | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": "<integer>",
"devices": [
{
"device_id": "<string>",
"device_name": "<string>",
"mac_address": "<string>",
"serial_number": "<string>",
"vendor": "<string>",
"model": "<string>",
"platform_os": "<string>",
"app_version": "<string>",
"tag": "<string>",
"enrolled_in_zdm": "<boolean>",
"connected_to_zdm": "<boolean>",
"room_id": "<string>",
"room_name": "<string>",
"device_type": 2,
"skd_version": "<string>",
"device_status": 1,
"last_online": "<string>",
"user_email": "<string>"
},
{
"device_id": "<string>",
"device_name": "<string>",
"mac_address": "<string>",
"serial_number": "<string>",
"vendor": "<string>",
"model": "<string>",
"platform_os": "<string>",
"app_version": "<string>",
"tag": "<string>",
"enrolled_in_zdm": "<boolean>",
"connected_to_zdm": "<boolean>",
"room_id": "<string>",
"room_name": "<string>",
"device_type": 1,
"skd_version": "<string>",
"device_status": 0,
"last_online": "<string>",
"user_email": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/devices?search_text=<string>&platform_os=iphone&is_enrolled_in_zdm=true&device_type=-1&device_vendor=<string>&device_model=<string>&device_status=-1&page_size=30&next_page_token=<string>?search_text=<string>&platform_os=iphone&is_enrolled_in_zdm=true&device_type=-1&device_vendor=<string>&device_model=<string>&device_status=-1&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS