---
title: "List all dashboards"
method: GET
path: "/v1/dashboards"
tags: ["Dashboards"]
---

# List all dashboards

`GET /v1/dashboards`

Lists all current dashboards in your account.

## Query parameters

- `limit` integer — Limit the number of results
- `page` number — Page number

## Headers

- `x-checkly-account` string, uuid — Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

## Response `200`

Successful

- DashboardListItem[]
  - `customUrl` string, nullable — A subdomain name under "checklyhq.com". Needs to be unique across all users.
  - `customDomain` string, nullable — A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
  - `logo` union — A URL pointing to an image file.
    - string, uri
    - ''
    - unknown
  - `favicon` union — A URL pointing to an image file used as dashboard favicon.
    - string, uri
    - ''
    - unknown
  - `link` union — A URL link to redirect when dashboard logo is clicked on.
    - string, uri
    - ''
    - unknown
  - `header` string — A piece of text displayed at the top of your dashboard.
  - `description` string, nullable — A piece of text displayed below the header or title of your dashboard.
  - `width` 'FULL' | '960PX' — Determines whether to use the full screen or focus in the center.
  - `refreshRate` number — How often to refresh the dashboard in seconds.
  - `paginate` boolean — Determines of pagination is on or off.
  - `paginationRate` number — How often to trigger pagination in seconds.
  - `sortByStatus` boolean — Sort checks by status with failing checks first.
  - `checksPerPage` number, nullable — Number of checks displayed per page.
  - `useTagsAndOperator` boolean, nullable — When to use AND operator for tags lookup.
  - `hideTags` boolean — Show or hide the tags on the dashboard.
  - `enableIncidents` boolean — Enable or disable incidents on the dashboard.
  - `expandChecks` boolean — Expand or collapse checks on the dashboard.
  - `tags` string[] — A list of one or more tags that filter which checks to display on the dashboard.
  - `showHeader` boolean — Show or hide header and description on the dashboard.
  - `showCheckRunLinks` boolean — Show or hide check run links on the dashboard.
  - `showGroupNames` boolean — Show or hide group names on the dashboard.
  - `customCSS` string, nullable — Custom CSS to be applied to the dashboard.
  - `isPrivate` boolean — Determines if the dashboard is public or private.
  - `showP95` boolean — Show or hide the P95 stats on the dashboard.
  - `showP99` boolean — Show or hide the P99 stats on the dashboard.
  - `keys` DashboardKey[] — Show key for private dashboard.
    - `id` string, uuid, required
    - `rawKey` string, required — The raw key value.
    - `maskedKey` string, required — The masked key value.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, nullable
  - `id` number, required
  - `dashboardId` string, required — The dashboard ID.
  - `created_at` string, date-time, required
  - `projectBindings` ProjectBindingsV1 — The Checkly CLI projects that manage this resource. `owner` is null and `references` empty when the resource is not managed by code.
    - `owner` ProjectBindingOwnerV1, nullable, required — The project that owns this resource — the one whose deploy can delete it. Null when no project owns it, including when other projects merely reference it. In the rare case that several projects hold an ownership record for one resource, this reports the preferred one and the rest are omitted.
      - `project` BindingProjectV1, required — The project this binding is to.
        - `id` string, required — The ID of the project.
        - `logicalId` string, required — The logical ID of the project, as declared in code.
        - `name` string, required — The name of the project.
      - `binding` ProjectBindingDetailsV1, required — The resource's side of this binding.
        - `logicalId` string, required — The resource's logical ID within this project, as declared in code.
        - `pending` boolean, required — True when the binding is reserved by an import plan that has not been deployed yet.
    - `references` ProjectBindingV1[], required — Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
      - `project` BindingProjectV1, required — The project this binding is to.
        - `id` string, required — The ID of the project.
        - `logicalId` string, required — The logical ID of the project, as declared in code.
        - `name` string, required — The name of the project.
      - `binding` ProjectBindingDetailsV1, required — The resource's side of this binding.
        - `logicalId` string, required — The resource's logical ID within this project, as declared in code.
        - `pending` boolean, required — True when the binding is reserved by an import plan that has not been deployed yet.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/checklyhq/apis/checkly-public-api.md) · [All operations](https://skmtc.net/checklyhq/apis/checkly-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/checklyhq/checkly-public-api/revisions/87d29dc7b4fe/schema)