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

# List dashboards

`GET /api/v1/query/dashboards`

## Request

- Base URL: `https://api.trigger.dev`
- URL: `https://api.trigger.dev/api/v1/query/dashboards`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api/docs/api/v1/query/dashboards/get.ts> (a function with typed inputs; its response is checked against the schema)

List the built-in dashboards and your organization's custom dashboards, with their widgets. Built-in dashboards contain pre-built TRQL queries for common metrics like run success rates, costs, and LLM usage.

## Response `200`

Dashboards listed successfully

- object
  - `dashboards` object[]
    - `key` string: Dashboard identifier. Built-in dashboards use a key like "overview" or "llm"; custom dashboards use their id.
    - `title` string: Dashboard display title
    - `type` 'builtIn' | 'custom': Built-in dashboards are read-only. Custom dashboards can be changed with the endpoints below.
    - `description` string: The dashboard description (custom dashboards only)
    - `widgets` object[]
      - `id` string: Widget identifier
      - `title` string: Widget display title
      - `query` string: The TRQL query this widget executes
      - `type` 'bignumber' | 'chart' | 'table': Widget display type

## Other responses

- `401`: Unauthorized - API key is missing or invalid

## Changes

- **2026-10-17** `15d1c9c9899c`: 2 info
  - added the optional property `dashboards/items/description` to the response with the `200` status
  - added the optional property `dashboards/items/type` to the response with the `200` status
- **2026-04-13** `2af886115b5b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api/changes/api/v1/query/dashboards/get.md)

---

[API](https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api.md) - [All operations](https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api/revisions/441161111493?raw)