---
title: "Get a status page"
method: GET
path: "/status_pages/{status_page_id}"
tags: ["Status pages"]
---

# Get a status page

`GET /status_pages/{status_page_id}`

## Request

- Base URL: `https://app.honeybadger.io/v3`
- URL: `https://app.honeybadger.io/v3/status_pages/{status_page_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/honeybadger/apis/honeybadger-api/docs/status_pages/:status_page_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a single status page.

## Path parameters

- `status_page_id` string, required

## Response `200`

Success

- object
  - `data` StatusPage, required: A public status page. Readable and deletable after the plan loses status pages; creating and editing need the feature.
    - `id` string, required
    - `account_id` string, required: ID of the account this status page belongs to
    - `name` string, required: Status page name
    - `domain` string, nullable, required: Custom domain for the status page
    - `features` StatusPageFeatures, required: Presentation copy and styling. Replaced whole by an update. A key that was never set is absent from a read; one sent as null reads back as null.
      - `home_link` string, nullable: URL the page header links to, usually your own site.
      - `up_caption` string, nullable: Text shown when every check is up. Unset, the page says "All systems are operational".
      - `down_caption` string, nullable: Text shown when every check is down. Unset, the page says "All systems are experiencing issues".
      - `mixed_caption` string, nullable: Text shown when only some checks are down. Unset, the page says "Some systems are experiencing issues".
      - `custom_css` string, nullable: CSS added to the page after its own styles.
    - `hide_branding` boolean, required
    - `password_protected` boolean, required
    - `username` string, nullable, required: Basic-auth user when password protected. The password is never returned.
    - `incidents_enabled` boolean, required: Whether the page shows incidents
    - `search_engine_indexing_disabled` boolean, required: Whether search engines are asked not to index the page
    - `message_enabled` boolean, required: Whether the message banner shows
    - `message_title` string, nullable, required: The message banner's title
    - `message_body` string, nullable, required: The message banner's text
    - `google_analytics_id` string, nullable, required: The page's Google Analytics measurement ID
    - `url` string, required: URL of the status page
    - `created_at` string, date-time, required: When the status page was created
    - `domain_verified_at` string, date-time, nullable, required: When the custom domain was verified
    - `sites` StatusPageSite[], required: Uptime sites displayed on the status page. An ordered list; the order is the order on the page.
      - `site_id` string, uuid, required: Identifier of the site
      - `display_name` string, nullable, required: Display name on the status page
      - `description` string, nullable, required: Description shown on the status page
    - `check_ins` StatusPageCheckIn[], required: Check-ins displayed on the status page. An ordered list; the order is the order on the page.
      - `check_in_id` string, required: ID of the check-in
      - `display_name` string, nullable, required: Display name on the status page
      - `description` string, nullable, required: Description shown on the status page
    - `links` WebLinks, required: Links into the Honeybadger web UI
      - `web` string, uri, required: The resource's page in the Honeybadger web UI, as an absolute URL. Resources without a page, such as outages and deploys, don't have `links`. For a project provisioned through Heroku, error, notice and comment links go through Heroku's single sign-on.
  - `meta` ResponseMeta
    - `request_id` string: Unique identifier for the request, for correlating with support

## Other responses

- `401`: The credential is missing, invalid, expired or revoked (`unauthorized`), or was sent in a way v3 doesn't accept (see the examples).
- `403`: The credential isn't allowed to do this. `error.code` says why. An account or project the credential doesn't cover is 404 `not_found`, not 403.
- `404`: Resource not found
- `422`: No path names the account, so the API token has to. This is returned when the token covers more than one account and the account a request applies to cannot be determined. Use a token bound to a single account.

---

[API](https://skmtc.dev/honeybadger/apis/honeybadger-api.md) - [All operations](https://skmtc.dev/honeybadger/apis/honeybadger-api/llms.txt) - [OpenAPI document](https://skmtc.dev/honeybadger/apis/honeybadger-api/revisions/cbcff53f2c8a?raw)