---
title: "List"
method: GET
path: "/devices"
tags: ["Devices"]
---

# List

`GET /devices`

List devices.

## Query parameters

- `offset` integer
- `limit` integer
- `order_by` DeviceOrderBy[]
- `expand` DeviceListExpansion[]
- `id` string[]
- `name` string[]
- `agent_version` string[]

## Response `200`

Successfully listed the devices.

- DeviceList
  - `object` 'list', required — The object type, which is always `list`.
  - `total_count` integer — The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.
  - `limit` integer, required — The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.
  - `offset` integer, required — The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.
  - `has_more` boolean, required — True if there are more items in the list to return. False if there are no more items to return.
  - `data` Device[], required — The list of devices.
    - `object` 'device', required — The object type, which is always `device`.
    - `id` string, required — ID of the device.
    - `name` string, required — Name of the device.
    - `status` 'inactive' | 'activating' | 'online' | 'offline', required — The status of the device. - Inactive: The miru agent has not yet been installed / authenticated - Activating: The miru agent is currently being installed / authenticated (should only last for a few seconds) - Online: The miru agent has successfully pinged the server within the last 60 seconds. - Offline: The miru agent has not successfully pinged the server within the last 60 seconds (e.g. network issues, device is powered off, etc.)
    - `agent_version` string, nullable, required — The version of the agent the device is running.
    - `last_connected_at` string, date-time, nullable, required — Timestamp of when the device was last made an initial connection (this is not the same as the last time the device was seen).
    - `last_disconnected_at` string, date-time, nullable, required — Timestamp of when the device was last disconnected (this is not the same as the last time the device was seen).
    - `created_at` string, date-time, required — Timestamp of when the device was created.
    - `updated_at` string, date-time, required — Timestamp of when the device was last updated.

---

[API](https://skmtc.dev/mirurobotics/apis/miru-platform-api.md) · [All operations](https://skmtc.dev/mirurobotics/apis/miru-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mirurobotics/miru-platform-api/revisions/7f0f7fc868da/schema)
