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

# List all dashboards

`GET /dashboards`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Retrieve a list of all dashboards the user can access. Pass `project_id` to scope to dashboards whose dataviews live in that project (used by the add-to-collection picker).

## Query parameters

- `project_id` integer, nullable

## Response `200`

Successfully Retrieved

- DashboardListSchema
  - `dashboards` DashboardModelType[], required: List of dashboards
    - `id` integer, required
    - `updated_at` string, date-time, required
    - `created_at` string, date-time, required
    - `status` 'draft' | 'published' | 'archived' | 'deleted' | 'error', required
    - `role` string, required
    - `sources` integer[], required
    - `share` unknown, required
    - `url` string, required
    - `updated_by` integer, required
    - `title` string, required
    - `theme` string, required
    - `auto_sync` object, required
    - `auto_publish` boolean, required
    - `is_sync_pending` boolean, required
    - `is_publish_pending` boolean, required
    - `is_publish_presentation_pending` boolean, required
    - `was_published` boolean, required
    - `sequence` integer, nullable
    - `sub_sequence` integer, nullable
    - `engine` string
    - `project_id` integer, nullable
    - `workspace_id` integer, nullable
    - `format` string, nullable
    - `archived` boolean
    - `tags` string[]
    - `page_count` integer, nullable
    - `shared_by_name` string, nullable
    - `collection_ids` integer[]
    - `personal` boolean
    - `unavailable_files` UnavailableFileType[]
      - `id` integer, required
      - `name` string, required
    - `source_files` UnavailableFileType[]
      - `id` integer, required
      - `name` string, required
    - `shared_with_count` integer

## Other responses

- `400`: Bad request syntax or unsupported method
- `403`: Request forbidden -- authorization will not help

---

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