---
title: "List Devices"
method: GET
path: "/v1/devices"
---

# List Devices

`GET /v1/devices`

## Request

- Base URL: `https://api.ui.com`
- URL: `https://api.ui.com/v1/devices`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/docs/v1/devices/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of UniFi devices managed by hosts where the UI account making the API call is the owner or a super admin. <br/><br/>**Note**: The structure of the `devices.uidb` field may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.1.13.

## Query parameters

- `hostIds[]` string[]
- `time` string
- `pageSize` string
- `nextToken` string

## Response `200`

200

- object
  - `code` unknown
  - `data` object[]: Generic response data, specific schema depends on the endpoint
    - `hostId` string: Unique identifier of the host device
    - `hostName` string: Name of the host device
    - `devices` object[]: Array of devices managed by this host
      - `id` string: Unique identifier of the device
      - `mac` string: MAC address of the device
      - `name` string: User-defined name of the device
      - `model` string: Model name of the device
      - `shortname` string: Short identifier of the device model (e.g., UDMPROSE)
      - `ip` string: IP address of the device
      - `productLine` string, nullable: Product line of the device (network, protect, etc.)
      - `status` string: Current connection status of the device (online, offline, etc.)
      - `version` string: Current firmware version of the device
      - `firmwareStatus` string: Status of device firmware (upToDate, updateAvailable, etc.)
      - `updateAvailable` string, nullable: Version of firmware update available for the device, if any
      - `isConsole` boolean, nullable: Indicates if the device is a console device
      - `isManaged` boolean, nullable: Indicates if the device is managed by the controller
      - `startupTime` string, date-time, nullable: Time when the device was last started in RFC3339 format
      - `adoptionTime` string, nullable: Time when the device was adopted in RFC3339 format
      - `note` string, nullable: User-defined notes for the device
      - `uidb` unknown
    - `updatedAt` string, date-time: Last update time in RFC3339 format
  - `httpStatusCode` integer: HTTP status code
  - `traceId` string: Request trace identifier
  - `nextToken` string: Pagination token for fetching the next set of results

## Other responses

- `400`: 400
- `401`: 401
- `429`: 429
- `500`: 500
- `502`: 502

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/revisions/16daa37f17c9?raw)