---
title: "Get a dashboard"
method: GET
path: "/v1/dashboards/{dashboardId}"
tags: ["Dashboards"]
---

# Get a dashboard

`GET /v1/dashboards/{dashboardId}`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/dashboards/{dashboardId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

One dashboard by id or slug, with its layout, widgets and filters. A private dashboard answers 404 to everyone but its owner.

## Path parameters

- `dashboardId` string, required: Dashboard ID

## Response `200`

The dashboard

- object
  - `success` true, required
  - `data` object, required
    - `dashboard` object, required
      - `id` string, required
      - `slug` string, required
      - `name` string, required

## Other responses

- `400`: Invalid input — an empty or oversized order, a dashboard listed twice, or a dashboard placed before itself
- `401`: Unauthorized
- `403`: Forbidden — missing `dashboards:write` scope or a role below editor
- `404`: Not found — the dashboard, the folder or the anchor is not one you can see, or dashboards are off
- `409`: Conflict — the folder changed while the move was planned; retry

---

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