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

# List Dashboards

`GET /api/v1/public/dashboards`

## Request

- Base URL: `https://app.traceroot.ai`
- URL: `https://app.traceroot.ai/api/v1/public/dashboards`
- Auth: HTTP bearer

List the dashboards in the caller's project (default first).

## Query parameters

- `project_id` string, nullable: Target project for the request. Required when authenticating with a user session token (a user credential is only meaningful scoped to a project); for an API key it is optional and, if given, must match the key's project.

## Response `200`

Successful Response

- PublicDashboardListResponse: The project's dashboards for the public API. Not paginated: a project's dashboard catalog is small and bounded.
  - `data` DashboardListItem[], required
    - `create_time` string, date-time, required
    - `creator` string, nullable, required
    - `description` string, nullable, required
    - `id` string, required
    - `is_default` boolean, required
    - `name` string, required
    - `update_time` string, date-time, required
    - `widget_count` integer, required

## Other responses

- `401`: Authentication failed
- `422`: Validation Error
- `503`: Authentication service unavailable

---

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