StatusDashboard
Components

Get component

Retrieve a single component by ID.

View Markdown

GET /app/components/{id}

Returns a single component by its ID.

Requires the admin, event, or subscriber role.


Path parameters

ParameterTypeDescription
idstringUUID of the component to retrieve.

Request

See API Basics for required headers.


Sample request

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

Sample response

Status: 200 OK

{
  "component": {
    "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"
  }
}

Response fields

The component object matches each item in List components.


Error responses

StatusWhen
403Insufficient permissions.
404No component with that ID exists in the organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.