Get the data of a device | TRMNL Octri Demo

1 parameter

idintegerrequired

The unique identifier of the device to retrieve.

3 status codes

200Returns a `data` object containing device details, including its identifiers, name, firmware information, connection timestamps, settings, and other device fields.

dataobjectoptional

401Returned when the request is unauthorized.

errorstringoptional

404Returned when the device is not found or belongs to another user.

errorstringoptional

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the device is not found or belongs to another user. The id path parameter must identify the device whose data you want to retrieve.

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.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "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
  }
}

Request

Response

Errors