---
title: "List embeddable Dashboards"
method: GET
path: "/api/v3/dashboards/embeddable/"
tags: ["Dashboards"]
---

# List embeddable Dashboards

`GET /api/v3/dashboards/embeddable/`

## Request

- Base URL: `https://embedded.improvado.io`
- URL: `https://embedded.improvado.io/api/v3/dashboards/embeddable/`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/docs/api/v3/dashboards/embeddable/get.ts> (a function with typed inputs; its response is checked against the schema)

Return IDs and titles of registered React Dashboards accessible to the API user
in the selected workspace. Public sharing does not need to be enabled. Dashboard
configuration, creator identities, file paths and access tokens are not returned.

Use a returned `dashboard_id` with `POST /api/v3/dashboards/{dashboard_id}/embed-session/`.
Listing a dashboard does not grant access to your application's viewers; authorize
each viewer on your backend before issuing a temporary URL.

Pagination follows catalog pages before unsupported entries are filtered out.
A page may contain fewer than `page_size` items, or be empty while `next_page` is set.
Continue requesting `next_page` with the same `workspace_id` and `page_size` until it
is null. No total count of embeddable dashboards is returned.

## Query parameters

- `workspace_id` integer, required
- `page` integer
- `page_size` integer

## Response `200`

Accessible Dashboards on this catalog page.

- EmbeddableDashboardList
  - `items` EmbeddableDashboard[], required
    - `dashboard_id` integer, required: Dashboard settings ID to use when issuing an embed URL.
    - `title` string, required: Dashboard display title.
  - `next_page` integer, nullable, required: Next catalog page to request, or null when no more pages remain. Follow even if items is empty.

## Other responses

- `400`: Missing or invalid workspace_id, page or page_size. Validation errors contain a detail array; request parsing errors contain a detail string.
- `401`: Valid Embedded API Basic credentials are required; cookie-only and Bearer authentication are not accepted.
- `403`: Workspace not found, insufficient dashboard-view permission, or Embedded API access is not enabled.
- `503`: Dashboard listing is temporarily unavailable. No partial list is returned for a failed upstream response.

---

[API](https://skmtc.dev/improvado/apis/improvado-embedded-api-v3.md) - [All operations](https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/revisions/a881099bd6c4?raw)