GET
/
devices
List
curl --request GET \
  --url https://{host}/{version}/devices \
  --header 'X-API-Key: <api-key>'
{
  "object": "list",
  "total_count": 123,
  "limit": 10,
  "offset": 0,
  "has_more": false,
  "data": [
    {
      "object": "device",
      "id": "dvc_123",
      "name": "My Device",
      "status": "inactive",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

The API key to use for authentication. Retrieve your API key from the Miru dashboard.

Query Parameters

​
offset
integer
default:0

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

Required range: x >= 0
​
limit
integer
default:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

Required range: 1 <= x <= 100
​
order_by
enum<string>
default:created_at:desc
Available options:
id:asc,
id:desc,
created_at:desc,
created_at:asc
​
expand[]
enum<string>[]

The fields to expand in the device list

​
id
string

The device ID to filter by

Example:

"dev_123"

​
name
string

The device name to filter by

Example:

"My Device"

Response

200 - application/json

Successfully listed the devices.

The response is of type object.