Displays

GET/v1/meVerify your key, see your plan

GET/v1/displaysList displays with vars + screens

GET/v1/displays/:idFull object — config, playlist, vars

PATCH/v1/displays/:idUpdate name, text, palette, animation

curl https://useglowbit.com/api/v1/displays \
  -H "Authorization: Bearer YOUR_KEY"

RESPONSE · 200 — GET /v1/displays

{
  "data": [
    {
      "id": "1KpZ2xN0aQ7RtY8uVw3Fb",
      "name": "Front Window",
      "workspaceId": "wZ3kQ…",
      "updatedAt": "2026-07-13T09:41:22.000Z",
      "vars": { "number": "042" },
      "screens": [ { "id": "sQ8vX…", "online": true } ]
    }
  ]
}

RESPONSE · 200 — GET /v1/displays/:id

{
  "id": "1KpZ2xN0aQ7RtY8uVw3Fb",
  "name": "Front Window",
  "workspaceId": "wZ3kQ…",
  "config": { "text": "NOW SERVING № {{number}}", "paletteId": "amber", "anim": "scroll", "…": "…" },
  "playlist": [ "…" ],
  "schedule": null,
  "vars": { "number": "042" },
  "screens": [ { "id": "sQ8vX…", "online": true } ],
  "createdAt": "2026-07-01T08:00:00.000Z",
  "updatedAt": "2026-07-13T09:41:22.000Z"
}

Updating a display

PATCH accepts at least one field of the four below. Unknown paletteId or anim values return 422 validation_failed. The response is the full updated display object; changes go live on paired screens immediately.

namestringDisplay name, 1–100 characters.

textstringMessage template, up to 500 characters. May contain {{variables}}.

paletteIdstringOne of: amber · red · gold · green · cyan · pink · white · cyber · sunset · miami

animstringOne of: static · scroll · blink · pulse · fade · flicker

curl -X PATCH https://useglowbit.com/api/v1/displays/YOUR_DISPLAY_ID \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "BACK IN 10 MINUTES", "anim": "blink" }'