---
title: "GET /api/dashboard/{dashboard_id}/widgets/"
method: GET
path: "/api/dashboard/{dashboard_id}/widgets/"
tags: ["Dashboard widgets"]
---

# GET /api/dashboard/{dashboard_id}/widgets/

`GET /api/dashboard/{dashboard_id}/widgets/`

Lists all the widgets of the dashboard related to the provided parameter if the user has access to the related workspace.

## Path parameters

- `dashboard_id` integer, required

## Response `200`

- DashboardWidgetWidget[]
  - union
    - SummaryWidgetWidget — Basic widget serializer mostly for returned values.
      - `id` integer, required
      - `title` string, required
      - `description` string, required
      - `dashboard_id` integer, required
      - `type` string, required — The type of the widget.
      - `order` string, decimal, required — Lowest first.
      - `data_source_id` integer — References a data source field for the widget.
    - ChartWidgetWidget — Basic widget serializer mostly for returned values.
      - `id` integer, required
      - `title` string, required
      - `description` string, required
      - `dashboard_id` integer, required
      - `type` string, required — The type of the widget.
      - `order` string, decimal, required — Lowest first.
      - `data_source_id` integer — References a data source field for the widget.
      - `series_config` ChartSeriesConfig[] — Provides series configuration.
        - `series_id` integer, required
        - `series_chart_type` 'BAR' | 'LINE', required — * `BAR` - Bar * `LINE` - Line
      - `default_series_chart_type` 'BAR' | 'LINE' — * `BAR` - Bar * `LINE` - Line
    - PieChartWidgetWidget — Basic widget serializer mostly for returned values.
      - `id` integer, required
      - `title` string, required
      - `description` string, required
      - `dashboard_id` integer, required
      - `type` string, required — The type of the widget.
      - `order` string, decimal, required — Lowest first.
      - `data_source_id` integer — References a data source field for the widget.
      - `series_config` PieChartSeriesConfig[] — Provides series configuration.
        - `series_id` integer, required
        - `series_chart_type` 'PIE' | 'DOUGHNUT', required — * `PIE` - Pie * `DOUGHNUT` - Doughnut
      - `default_series_chart_type` 'PIE' | 'DOUGHNUT' — * `PIE` - Pie * `DOUGHNUT` - Doughnut

## Other responses

- `401`
- `404`

---

[API](https://skmtc.net/baserow/apis/baserow-api-spec.md) · [All operations](https://skmtc.net/baserow/apis/baserow-api-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/baserow/baserow-api-spec/versions/0c490e5b0c7f/schema)
