---
title: "listDashboards"
method: GET
path: "/v1/dashboard/dashboards"
tags: ["Dashboards"]
---

# listDashboards

`GET /v1/dashboard/dashboards`

List dashboards available to the user

## Query parameters

- `q` string
- `created_by` string
- `created_after` string, date-time
- `created_before` string, date-time
- `updated_after` string, date-time
- `updated_before` string, date-time
- `shared_with` string[]
- `owner` string[]
- `accessible_to` string
- `favorite` boolean
- `favorites_first` boolean
- `sort` 'created_at' | 'updated_at' | 'name' | 'title'
- `order` 'asc' | 'desc'
- `limit` integer
- `offset` integer

## Response `200`

List of dashboards available to the user

- object
  - `results` Dashboard[], required
    - `created_by` string — Id of the user who created the resource
    - `created_at` string, date-time
    - `updated_by` string — Id of the user who last updated the resource
    - `updated_at` string, date-time
    - `owner_org_id` string — Id of the organisation that owns the resource. Set at creation time and immutable.
    - `owners` string[] — User ids with full control over the resource (view, edit, delete and manage sharing). The creator is always an owner. There must always be at least one owner.
    - `shared_with` ShareGrant[] — Per-user sharing grants
      - `user_id` string, required — The id of the user the resource is shared with
      - `permission` 'view' | 'edit', required — Permission level granted to a user (or the whole organization) on a shared resource. `view` allows read-only access; `edit` additionally allows updating the content. Full control (delete and managing sharing) is reserved for owners.
    - `org_access` union — Optional organization-wide grant. When set, every user in the resource's organization is granted this permission level. `null` (or omitted) means the resource is not shared org-wide.
      - 'view' | 'edit'
      - unknown
    - `id` string, uuid — Unique identifier for dashboard
    - `title` string, required
    - `tiles` DashboardTile[], required
      - `id` string, uuid — Unique identifier for a tile in a dashboard
      - `coordinates` object
      - `title` string
      - `insight_id` string, uuid — Unique identifier for an insight (a saved chart / visualisation)
      - `visualisation_id` 'kpi' | 'funnel' | 'toplist' | 'timechart' | 'pie' | 'bar' | 'entity_list' | 'markdown' | 'news_feed' | 'workflow' — Unique identifier for a Visualisation
      - `visualisation_config` VisualisationConfig
        - `query` DatalakeQuery
          - `dataset` string
          - `measure` string
          - `dimensions` object[]
          - `filters` object[]
        - `options` object
    - `favorited` boolean — Whether the requesting user has favorited this dashboard.
    - `version` integer — Schema version of the dashboard, set at creation and immutable afterwards. `1` is a dashboard authored in the classic dashboard UI, `2` in the analytics surface. Omit on create to default to `1`. Ignored on PUT and PATCH.
  - `pagination` Pagination, required — Offset-based pagination metadata for list responses
    - `total` integer, required — Total number of results matching the query (ignoring limit/offset)
    - `limit` integer, required — Page size used for this response
    - `offset` integer, required — Number of results skipped before this page
    - `has_more` boolean, required — Whether more results exist beyond this page

## Changes

- **2026-08-18** `91d9e23375ac` — 1 info
  - added the optional property `results/items/allOf[subschema #2]/version` to the response with the `200` status
- **2026-08-07** `59651f8bc5ff` — 3 info
  - added the new optional `query` request parameter `favorite`
  - added the new optional `query` request parameter `favorites_first`
  - added the optional property `results/items/allOf[subschema #2]/favorited` to the response with the `200` status

[Change history](https://skmtc.dev/epilot/apis/dashboard-api/changes/v1/dashboard/dashboards/get.md)

---

[API](https://skmtc.dev/epilot/apis/dashboard-api.md) · [All operations](https://skmtc.dev/epilot/apis/dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/epilot/dashboard-api/revisions/91d9e23375ac/schema)