---
title: "List dashboards"
method: GET
path: "/v1/dashboard"
tags: ["Dashboard"]
---

# List dashboards

`GET /v1/dashboard`

## Request

- Base URL: `https://api.roark.ai`
- URL: `https://api.roark.ai/v1/dashboard`
- Auth: HTTP bearer

Lists the project's dashboards, the default first. GET /v1/dashboard/{dashboardId} returns the widgets.

## Response `200`

The dashboards

- object
  - `data` DashboardSummary[], required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `isDefault` boolean, required
    - `configManaged` boolean, required: Managed by config as code (`kind: dashboard`). A managed dashboard is read-only here: edits return 409; change it in the config file.
    - `timeRange` union, required: The window: LAST n DAYS/WEEKS/MONTHS up to now, a CALENDAR_ALIGNED period (TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, THIS_YEAR, LAST_YEAR), FIXED from/to, or SINCE a date. At most 731 days (two years).
      - object
        - `type` 'LAST', required
        - `value` integer, required
        - `unit` 'DAYS' | 'WEEKS' | 'MONTHS', required
      - object
        - `type` 'CALENDAR_ALIGNED', required
        - `period` 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR', required
      - object
        - `type` 'FIXED', required
        - `from` string, date-time, required
        - `to` string, date-time, required
      - object
        - `type` 'SINCE', required
        - `from` string, date-time, required
    - `createdAt` string, required
    - `updatedAt` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Dashboard or widget not found
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

> 187 revisions in range; 1 not diffed.

- **2026-10-21** `2e403107d6ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/roarkhq/apis/roark-analytics-api/changes/v1/dashboard/get.md)

---

[API](https://skmtc.dev/roarkhq/apis/roark-analytics-api.md) - [All operations](https://skmtc.dev/roarkhq/apis/roark-analytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/roarkhq/apis/roark-analytics-api/revisions/1a91a5c90e44?raw)