Read the screens a collection is showing on

2 parameters

installation_idstringrequired

Room booking installation id

idintegerrequired

Collection id

3 status codes

200The devices showing it

dataarray<object>optional

401Unauthorized

errorstringoptional

404Collection belongs to another installation

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Collection belongs to another installation.

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

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

const result = await client.screens.list({
  installationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "data": [
    {
      "device_id": "550e8400-e29b-41d4-a716-446655440000",
      "device_name": "Boardroom display",
      "screen": {
        "filename": "weather-1696161600",
        "image_url": "https://trmnl-screens.s3.amazonaws.com/...",
        "mashup_id": 1,
        "playlist_item_id": 1,
        "plugin_setting_id": 1,
        "rendered_at": "2023-10-01T12:00:00Z"
      }
    }
  ]
}

Request

Response

Errors