List devices | TRMNL Octri Demo

2 status codes

200Returns an object containing a `data` array of device records, including device identifiers and details such as names, firmware, battery, and connectivity information.

dataarray<object>optional

401Returned when the request is unauthorized.

errorstringoptional

Error handling

A 401 is returned when the request is unauthorized. Send valid credentials in the Authorization header to access the authenticated user's devices.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.devices.list();

{
  "data": [
    {
      "auto_advance": true,
      "battery_voltage": 3.7,
      "firmware_channel": "production",
      "firmware_version": "1.8.14",
      "friendly_id": "ABC-123",
      "hardware_last_ping_at": "2026-03-31T14:30:00.000Z",
      "id": 123,
      "last_ping_at": "2026-03-31T14:30:00.000Z",
      "low_battery_notification_enabled": true,
      "mac_address": "••:••:••:••:9A:BC",
      "mashup_layouts": {
        "1Lx1R": [
          "a",
          "b"
        ],
        "2x2": [
          "a",
          "b",
          "c",
          "d"
        ]
      },
      "name": "My TRMNL",
      "orientation": 0,
      "ota_enabled": true,
      "percent_charged": 85,
      "pinned_firmware_version": "1.8.14",
      "refresh_interval": 900,
      "rssi": -70,
      "sleep_end_time": 480,
      "sleep_mode_enabled": false,
      "sleep_screen_enabled": true,
      "sleep_start_time": 1320,
      "sleep_until": "2026-10-01T15:00:00.000Z",
      "wifi_band": "5",
      "wifi_strength": 75
    }
  ]
}

Response

Errors