This API returns the list of devices in the given department.

GET /api/v2/devices


OAuth Scope

ZohoAssist.unattended.computer.READ


Headers

  • Headers
    Data Type
    Description
  • x-com-zoho-assist-department-id *
    Long
    Required
    The department id for which the devices list is requested.
  • source
    String
    Optional
    The source from which the request is made.

Query Params

  • Parameters
    Data Type
    Description
  • index
    Integer
    Optional
    Default(1)
    Position of computer in the list.
  • count
    Integer
    Optional
    Default(25)
    Range(1-50)
    Number of records to be given in the response.
  • include
    String
    Optional (comma(,) separated string)
    domain|network|manufacturer|favorites|logged_on_users
    The details to be included in response.
  • recent
    Boolean
    Optional
    Returns only recently connected devices.
  • favorites
    Boolean
    Optional
    Returns only favorite devices.
  • sort_by
    String
    Optional
    display_name|device_name|agent_version|public_ip|private_ip|computer_full_name|os_platform|os_name|os_version
    The column by which the data must be sorted.
  • is_ascending
    Boolean
    Optional
    Sort Direction
  • resource_type
    Integer
    Optional
    Allowed Values: 2|4
    Only Computers - 2 Only Handhelds - 4
  • group_ids
    String
    Optional(Optional (comma (,) separated))
    Groups Ids for filtering devices
  • device_status
    String
    Optional(Optional (comma (,) separated))
    Device Status
  • installation_status
    String
    Optional(Optional (comma (,) separated integers))
    Installation Status
  • os_platforms
    String
    Optional(Optional (comma (,) separated))
    OS Platforms
  • os_names
    String
    Optional(Optional (comma (,) separated))
    OS Names
  • os_versions
    String
    Optional(Optional (comma (,) separated))
    Os Versions
  • domain_ids
    String
    Optional(Optional (comma (,) separated))
    Domain IDs
  • display_name
    String
    Optional
  • device_name
    String
    Optional
  • display_name
    String
    Optional
  • public_ip
    String
    Optional
  • private_ip
    String
    Optional
  • agent_version
    String
    Optional
  • computer_full_name
    String
    Optional
  • os_platform
    String
    Optional
  • os_name
    String
    Optional
  • os_version
    String
    Optional
  • domain_name
    String
    Optional
  • manufacturer
    String
    Optional
  • product
    String
    Optional

Note: Total will be included only for the request with index as 1.

Get Unattended Computer

RequestResponse
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"
}