---
title: "Get SqlDashboard by ID"
method: GET
path: "/api/v3/sql-dashboard/{sql_dashboard_id}"
tags: ["SQL Dashboard"]
---

# Get SqlDashboard by ID

`GET /api/v3/sql-dashboard/{sql_dashboard_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/sql-dashboard/{sql_dashboard_id}`
- Auth: HTTP bearer

Get a single SqlDashboard by ID.

## Path parameters

- `sql_dashboard_id` string, required

## Query parameters

- `returning` string[]
- `omit` string[]

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- SqlDashboard: A SqlDashboard is a configurable analytics page that displays one or more SQL-driven visualizations within Benchling Insights. Dashboards belong to a Project and contain ordered blocks (see SqlDashboardBlock), each with its own SQL query and chart or table visualization. Dashboards support parameterConfigs (see SqlParameterConfig) that allow users to filter data dynamically through dropdowns, date pickers, or entity selectors. SQL Dashboards query Benchling's data warehouse.
  - `__typename` string
  - `blocks` string, uri
  - `createdAt` string, datetime
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `description` string
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string
  - `project` ProjectRef
    - `__typename` string
    - `id` string, api_id

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/3873a10bf7b8?raw)