Get dashboard — StatusDashboard Docs

GET /app/dashboards/{id}

Returns the general settings for a single dashboard.

Requires the admin role. Subscriber management flows use List dashboards and Get dashboard components; they do not call this endpoint.

This endpoint returns only the core general fields. Tab-specific settings are retrieved via dedicated endpoints — see Domains, Components, Content, Custom Code, Branding, Email Sender, Widget, API, and Whitelabel.

Path parameters

Parameter	Description
`id`	The UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.

Sample request

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

Sample response

Status: 200 OK

{
  "dashboard": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "tenantId": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
    "name": "Production Status",
    "subdomain": "acme",
    "description": "Status dashboard for all Acme services",
    "systemMessage": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Welcome to Acme's status dashboard.\"}]}]}",
    "enabled": true,
    "createdAt": "2026-01-10T12:00:00.000Z",
    "updatedAt": "2026-04-01T08:00:00.000Z"
  }
}

Response fields

Field	Type	Description
`id`	string	Unique dashboard ID (UUID).
`tenantId`	string	Organization ID.
`name`	string	Dashboard display name.
`subdomain`	string	Subdomain slug.
`description`	string	Short dashboard description.
`systemMessage`	string \| absent	Optional message at the top of the status dashboard. Rich text field. See Rich text fields. Max 1,000 characters. Absent when not set.
`enabled`	boolean	Whether the dashboard is publicly accessible.
`createdAt`	string	ISO 8601 UTC creation timestamp.
`updatedAt`	string	ISO 8601 UTC last-updated timestamp.

Error responses

Status	When
`403`	Insufficient permissions.
`404`	Dashboard not found or does not belong to the caller's organization.