Components
List components
List all components for the organization.
GET /app/components
Returns all components belonging to the caller's organization.
Requires the admin, event, or subscriber role. Create, update (PATCH), and delete operations remain admin-only.
Request
See API Basics for required headers.
This endpoint takes no request body or query parameters.
Sample request
curl https://api.statusdashboard.com/app/components \
-H "Authorization: Bearer bcf847abf5c6:def456"Sample response
Status: 200 OK
{
"components": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "API",
"description": "REST API and webhooks",
"currentStatus": "Operational",
"currentStatusSnapshot": {
"label": "Operational",
"color": "#10b981",
"icon": "check-circle"
},
"statusUpdatedAt": "2026-04-01T08:00:00.000Z",
"createdAt": "2026-01-10T12:00:00.000Z"
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Web App",
"description": "Customer-facing dashboard",
"currentStatus": "Degraded Performance",
"currentStatusSnapshot": {
"label": "Degraded Performance",
"color": "#f59e0b",
"icon": "alert-triangle"
},
"statusUpdatedAt": "2026-04-24T14:30:00.000Z",
"createdAt": "2026-01-10T12:05:00.000Z",
"activeInformationalCount": 2
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
id | string | UUID uniquely identifying the component. |
name | string | Display name of the component. |
description | string | Optional description. Empty string if not set. |
currentStatus | string | Current status label. Operational when no active incident or maintenance applies; otherwise one of your organization's configured severity labels (for example Degraded Performance). |
currentStatusSnapshot | object | Display properties for currentStatus: label, color (hex), and icon (approved icon name). |
statusUpdatedAt | string | ISO 8601 UTC timestamp of the last status change. |
createdAt | string | ISO 8601 UTC timestamp when the component was created. |
activeInformationalCount | number | Optional. Count of published informational notices currently referencing this component. Omitted when zero. |
Error responses
| Status | When |
|---|---|
403 | Insufficient permissions. |