---
title: "Retrieves a list of devices."
method: GET
path: "/api/v1/accounts/{accountId}/devices"
---

# Retrieves a list of devices.

`GET /api/v1/accounts/{accountId}/devices`

## Request

- Base URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt`
- URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt/api/v1/accounts/{accountId}/devices`
- Auth: API key in header `WatchGuard-API-Key` and HTTP bearer
- TypeScript: <https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/docs/api/v1/accounts/:accountId/devices/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of devices, and additional information, such as the device IP address and operating system. The response to this request is limited to 3,000 records.

## Path parameters

- `accountId` string, required

## Query parameters

- `top` integer
- `skip` integer
- `search` string
- `count` boolean
- `orderby` string
- `config` boolean

## Response `200`

OK

- DevicesResultFindResponse
  - `data` DevicesResult
    - `device_id` string, uuid: Identifier for the device.
    - `account_id` string, uuid: Identifier for the account.
    - `site_id` string, uuid: Identifier for the site.
    - `site_name` string: Name of the site the device belongs to.
    - `host_name` string: Host name of the device.
    - `type` integer: Type of device. - 1: Workstation - 2: Laptop - 3: Server - 4: Mobile device
    - `description` string: Description of the device.
    - `domain` string: Domain to which your devices belong on Microsoft networks.
    - `platform_id` 1 | 2 | 3 | 4 | 5: Device platform. - 1: Windows - 2: Linux - 3: macOS - 4: Android - 5: iOS
    - `ip_address` string: IP address of the device.
    - `mac_addresses` string[]
    - `operating_system` string: Name of the operating system installed on the device.
    - `license_status` 0 | 1 | 2 | 3: Status of the device license. - 0: Assigned - 1: Not assigned - 2: Manual deallocation - 3: Auto deallocation
    - `isolation_state` 0 | 1 | 2 | 3: Isolation state of the device. - 0: Not isolated - 1: Isolated - 2: Applying isolation - 3: Removing isolation
    - `encryption` 0 | 1 | 2 | 3 | 4 | 5 | 6: Device encryption status. - 0: Without protection or without information - 1: Activated - 2: Deactivated - 3: Error - 4: Error installing - 5: Without license - 6: Not available
    - `reinstall_protection_requested` boolean: Indicates whether reinstallation of protection is requested.
    - `reinstall_agent_requested` boolean: Indicates whether reinstallation of the agent is requested.
    - `reboot_requested` boolean: Indicates whether a device reboot is requested.
    - `agent_version` string: Version of the agent installed in the endpoint.
    - `last_connection` string, date-time: Date and time of the last connection of the device.
    - `security_configuration_id` string, uuid: Identifier of the security configuration.
    - `security_configuration_name` string: Name of the security configuration.
    - `logged_on_users_list` string[]
    - `custom_group_folder_path` string: Full path to the group the device is assigned to.
    - `active_directory_canonical_name` string: Full canonical path to the device in Active Directory.
  - `total_items` integer, nullable: Optionally, if Count parameter is provided, we return here the total number of items

## Other responses

- `400`: BAD REQUEST.
- `403`: ACCESS DENIED.
- `404`: NOT FOUND.
- `405`: METHOD NOT ALLOWED.
- `500`: INTERNAL ERROR.

---

[API](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api.md) - [All operations](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/llms.txt) - [OpenAPI document](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/revisions/1376eee70d39?raw)