List my playlist items | TRMNL Octri Demo

2 status codes

200Returns an object containing a `data` array of playlist items, including item identifiers, device and plugin associations, appearance settings, and ordering.

dataarray<object>optional

401Returned when the request is unauthenticated.

errorstringoptional

Error handling

A 401 is returned when the request is unauthenticated; send a valid Authorization header.

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

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

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

{
  "data": [
    {
      "configuration_state": "configured",
      "created_at": "2023-10-01T12:00:00Z",
      "device_id": 1,
      "font_family": "classic",
      "id": 1,
      "mashup_id": 1,
      "mirror": true,
      "palette_id": "bw",
      "plugin": {
        "description": "Example description",
        "id": 1,
        "image": "https://example.com/image.jpg",
        "image_dark": "https://example.com/image.jpg",
        "keyname": "weather",
        "name": "Weather"
      },
      "plugin_id": 1,
      "plugin_setting": {
        "description": "Upcoming train departures",
        "health_notification_enabled": false,
        "icon_content_type": "image/png",
        "icon_url": "https://trmnl-public.s3.com/qwertyasdf",
        "id": 1,
        "name": "My Plugin Setting",
        "plugin_id": 1,
        "read_only?": false,
        "refresh_interval": 60,
        "strategy": "webhook",
        "sync": {
          "action_id": "550e8400-e29b-41d4-a716-446655440000",
          "reason": "example_value",
          "source_kinds": [
            "example_value"
          ],
          "upload_allowed": true
        }
      },
      "plugin_setting_id": 1,
      "rendered_at": "2023-10-01T12:00:00Z",
      "row_order": 1,
      "text_scale": "large",
      "theme": "dark",
      "updated_at": "2023-10-01T12:00:00Z",
      "visible": true
    }
  ]
}

Response

Errors