---
title: "Query dashboards"
method: GET
path: "/v1/projects/{project_id}/dashboards"
tags: ["Dashboard"]
---

# Query dashboards

`GET /v1/projects/{project_id}/dashboards`

## Request

- Base URL: `https://api.telerivet.com`
- URL: `https://api.telerivet.com/v1/projects/{project_id}/dashboards`
- Auth: one of:
  - HTTP basic
  - OAuth 2 (authorization code, authorization URL `https://telerivet.com/oauth/authorize`, token URL `https://api.telerivet.com/oauth/token`)

Queries saved dashboards within the given project.

 (If the project has never had a custom dashboard, its automatically generated default dashboard is not returned by this method; it can be retrieved via project.getDashboardById with the ID `default`.)

## Path parameters

- `project_id` string, required

## Query parameters

- `name` string
- `solution_id` string: ID of Solution
- `time_created[min]` integer: Unix timestamp in seconds
- `time_created[max]` integer: Unix timestamp in seconds
- `sort` 'default' | 'name'
- `sort_dir` 'asc' | 'desc'
- `page_size` integer
- `offset` integer
- `marker` string
- `count` boolean

## Response `200`

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

- object
  - `data` Dashboard[]: Array of results (omitted when count=1)
    - `id` string: ID of the dashboard, or `default` for an automatically generated dashboard that has not been saved yet
    - `name` string: Name of the dashboard
    - `solution_id` string, nullable: ID of the solution that this dashboard belongs to, if any
    - `cards` object[]: Summaries of the cards on this dashboard, in display order. Only returned when retrieving a single dashboard by ID.
      - `id` string: ID of the card
      - `type` string: Type of the card
      - `title` string: Displayed title of the card
    - `vars` object: Custom variables stored for this dashboard. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.
    - `time_created` integer, nullable: Time the dashboard was created in Telerivet (null for an automatically generated dashboard that has not been saved)
    - `time_updated` integer, nullable: Time the dashboard was last updated in Telerivet
    - `project_id` string: ID of the project this dashboard belongs to
    - `url` string: URL to this dashboard in the Telerivet web app
  - `truncated` boolean: True if there are more results
  - `next_marker` string: Marker for pagination
  - `page_size` integer: Number of results per page
  - `sort_dir` 'asc' | 'desc': Sort direction
  - `count` integer: Total count of matching items (only when count=1 parameter is provided)

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key or Bearer token
- `404`: Resource not found

---

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