Get dashboard components — StatusDashboard Docs

GET /app/dashboards/{id}/components

Returns the component display settings and group configuration for a dashboard.

Requires the admin or subscriber role. Used when assigning components to subscribers; the event role does not call this endpoint.

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/components \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "compact": false,
  "groups": {
    "enabled": true,
    "expandByDefault": true,
    "items": [
      { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "name": "Infrastructure", "order": 1 },
      { "id": "e5f6a7b8-c9d0-1234-ef01-345678901234", "name": "Application", "order": 2 }
    ]
  },
  "components": {
    "a1b2c3d4-e5f6-7890-abcd-ef1234567891": { "displayOrder": 1 },
    "f6a7b8c9-d0e1-2345-f012-456789012345": { "displayOrder": 2, "groupId": "d4e5f6a7-b8c9-0123-def0-234567890123" },
    "a7b8c9d0-e1f2-3456-0123-567890123456": { "displayOrder": 3, "groupId": "e5f6a7b8-c9d0-1234-ef01-345678901234" }
  }
}

Response fields

Same fields as Update dashboard components.

Error responses

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