# List a page's components

`GET https://evohub.io/api/v1/pages/{pageID}/components`

Part of the [Status API](https://docs-dev.evohub.io/status.md) reference · operationId `listComponents`.

The page's components in display order. A monitor-linked component's
`current_status` is its monitor's live state (the stored one if Uptime is slow
to answer), exactly as the public page shows it; `shown_status` and
`shown_because` say when a live incident or maintenance shows it differently.

**Permission (API-key scope):** `status:component:read`.

## Authorization

Any one of:

- `bearerAuth` (status:component:read)
- `apiKeyHeader` (status:component:read)

Where:

- `bearerAuth`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `apiKeyHeader`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Path parameters

- `pageID` (string (uuid), required, example `3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42`): The status page's id (a UUID).

## Responses

### 200 — The components.

Content type: `application/json`

Type: `object`

- `data` (array of Component, required)
  - `id` (string (uuid), required)
  - `org_id` (string, required)
  - `page_id` (string (uuid), required)
  - `name` (string, required)
  - `description` (string)
  - `source` (string, required, one of `manual`, `uptime_monitor`)
  - `monitor_id` (string): The Uptime monitor it mirrors (source `uptime_monitor`).
  - `current_status` (ComponentStatus, required, one of `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`)
  - `position` (integer, required)
  - `group` (string): The group (product) it appears under; absent when ungrouped.
  - `shown_status` (ComponentStatus, one of `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`): In the page's component list only, and only when a live incident or maintenance shows it differently from `current_status` on the public page.
  - `shown_because` (string): The live incident's or maintenance's title that makes visitors see `shown_status`.
  - `created_at` (string (date-time), required)
  - `updated_at` (string (date-time), required)
- `success` (boolean, required, value `true`)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.

### 404 — No such item, or one the caller cannot see (`NOT_FOUND`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.

### 429 — Too many requests (`RATE_LIMITED`). Wait `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.

## Example request

```bash
curl -X GET 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/components' \
  -H 'Authorization: Bearer <TOKEN>'
```
