Get dashboard digital signs — StatusDashboard Docs

GET /app/dashboards/{id}/digital-signs

Returns all digital signs configured on a dashboard. Requires the Digital Signs feature entitlement.

Plan quota (signsPerDashboard) and logo entitlement (customBranding) come from the org account payload. Host / subdomain fields for building public URLs come from Get domains.

Path parameters

Parameter	Description
`id`	The UUID of the dashboard.

Sample request

curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/digital-signs \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "signs": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "path": "noc-lobby",
      "enabled": true,
      "title": "NOC Overview",
      "message": "",
      "compact": false,
      "darkMode": false,
      "logoKey": "tenant-assets/org-id/dash-id/digital-signs/550e8400-e29b-41d4-a716-446655440000/logo.png",
      "logoUrl": "https://assets.statusdashboard.com/tenant-assets/org-id/dash-id/digital-signs/550e8400-e29b-41d4-a716-446655440000/logo.png",
      "groups": {
        "enabled": true,
        "items": [
          {
            "id": "660e8400-e29b-41d4-a716-446655440001",
            "name": "Edge",
            "order": 1
          }
        ]
      },
      "components": {
        "770e8400-e29b-41d4-a716-446655440002": {
          "displayOrder": 1,
          "groupId": "660e8400-e29b-41d4-a716-446655440001"
        }
      }
    },
    {
      "id": "880e8400-e29b-41d4-a716-446655440003",
      "path": "lobby",
      "enabled": false,
      "title": "Lobby Display",
      "compact": true,
      "darkMode": true,
      "groups": {
        "enabled": false,
        "items": []
      },
      "components": {
        "770e8400-e29b-41d4-a716-446655440002": {
          "displayOrder": 1
        }
      }
    }
  ]
}

Response fields

Field	Type	Description
`signs`	array	Array of digital sign records for this dashboard (may be empty).
`signs[].id`	string	Stable UUID for the sign (used for logo upload keys and admin UI).
`signs[].path`	string	Public URL segment: `/sign/{path}` on the dashboard host.
`signs[].enabled`	boolean	When `false`, the public sign returns 404.
`signs[].title`	string	Title shown on the sign display.
`signs[].message`	string \| omitted	Optional rich-text message (TipTap JSON string).
`signs[].compact`	boolean	Compact component layout on the sign. Requires Custom branding on the public sign display; stored either way.
`signs[].darkMode`	boolean	When `true`, the sign display uses a dark background; when `false` (default), a light background. Requires Custom branding on the public sign display; stored either way.
`signs[].logoKey`	string \| omitted	Internal object key when a logo is set (admin only; not on the public sign API). Requires Custom branding.
`signs[].logoUrl`	string \| omitted	Public URL for the sign logo when set. Requires Custom branding on the public sign display.
`signs[].groups`	object	Per-sign grouping (`enabled`, `items`). Named groups always render expanded on the sign display. Writable fields match Update dashboard digital signs.
`signs[].components`	object	Map of component UUID → `{ displayOrder, groupId? }` (subset of dashboard-wired components).

Error responses

Status	When
`403`	Digital Signs feature not enabled.
`404`	Dashboard not found or not in the caller's organization.

Path parameters

Sample request

Sample response

Response fields

Error responses

On this page