This API returns the list of devices in the given department.
GET /api/v2/devices
OAuth Scope
ZohoAssist.unattended.computer.READ
Headers
- HeadersData TypeDescription
- x-com-zoho-assist-department-id *Long
RequiredThe department id for which the devices list is requested. - sourceString
OptionalThe source from which the request is made.
Query Params
- ParametersData TypeDescription
- indexInteger
Optional
Default(1)Position of computer in the list. - countInteger
Optional
Default(25)
Range(1-50)Number of records to be given in the response. - includeString
Optional (comma(,) separated string)
domain|network|manufacturer|favorites|logged_on_usersThe details to be included in response. - recentBoolean
OptionalReturns only recently connected devices. - favoritesBoolean
OptionalReturns only favorite devices. - sort_byString
Optional
display_name|device_name|agent_version|public_ip|private_ip|computer_full_name|os_platform|os_name|os_versionThe column by which the data must be sorted. - is_ascendingBoolean
OptionalSort Direction - resource_typeInteger
Optional
Allowed Values: 2|4Only Computers - 2 Only Handhelds - 4 - group_idsString
Optional(Optional (comma (,) separated))Groups Ids for filtering devices - device_statusString
Optional(Optional (comma (,) separated))Device Status - installation_statusString
Optional(Optional (comma (,) separated integers))Installation Status - os_platformsString
Optional(Optional (comma (,) separated))OS Platforms - os_namesString
Optional(Optional (comma (,) separated))OS Names - os_versionsString
Optional(Optional (comma (,) separated))Os Versions - domain_idsString
Optional(Optional (comma (,) separated))Domain IDs - display_nameString
Optional - device_nameString
Optional - display_nameString
Optional - public_ipString
Optional - private_ipString
Optional - agent_versionString
Optional - computer_full_nameString
Optional - os_platformString
Optional - os_nameString
Optional - os_versionString
Optional - domain_nameString
Optional - manufacturerString
Optional - productString
Optional
Note: Total will be included only for the request with index as 1.
Get Unattended Computer
Copiedcurl --location 'https://assist.zoho.com/api/v2/devices' \
--header 'x-com-zoho-assist-department-id: 27*************' \
--header 'source: request source' \
--header 'Authorization: Zoho-oauthtoken 1000.84f8*****************************************'
Copied{
"representation": {
"count": 1,
"computers": [
{
"urs_key": "92B2**********",
"display_name": "Malcolm's Device",
"device_info": {
"name": "Malcolm-Workstation",
"installation_status": 1,
"device_name": "Malcolm-Workstation",
"device_status": 2,
"private_ip_address": "192.***.***.***",
"public_ip_address": "10.***.***.**",
"status": "offline",
"deployment_status": "Installed"
},
"platform_details": {
"os_platform": "windows",
"os_name": "Windows 10 Pro",
"os_version": "6.3"
},
"resource_id": "2750***********",
"added_by": "743*****",
"added_time": "1677473317591",
"updated_time": "1683983999745"
}
]
},
"resource_type": "/api/v2/devices"
}