Dashboards

Get Dashboard

Retrieve details of a specific dashboard. Pass include=widgets to include the dashboard's widgets in the response.

Note: Dashboard APIs are available on cloud-hosted Enterprise plans, and on licensed self-hosted deployments (Business plan and above).

get/api/v3/meta/bases/{baseId}/dashboards/{dashboardId}

Request

Base URL
https://app.nocodb.com
Auth
- API key in header xc-token
- or HTTP bearer
TypeScript
https://skmtc.dev/nocodb/apis/nocodb-v3/docs/api/v3/meta/bases/:baseId/dashboards/:dashboardId/get.ts
A function with typed inputs. Its response is checked against the schema.

baseIdstring required

Unique identifier for the base.

dashboardIdstring required

Unique identifier for the dashboard.

includestring[]

Include additional data. include=widgets adds the dashboard's widgets to the response.

Dashboard details retrieved.

idstring required

Unique identifier for the dashboard.

titlestring required

Title of the dashboard.

descriptionstring nullable

Description of the dashboard.

base_idstring required

Unique identifier for the base.

workspace_idstring required

Unique identifier for the workspace.

created_atstring date-time required

Timestamp when the dashboard was created.

updated_atstring date-time required

Timestamp when the dashboard was last updated.

created_bystring

User ID of the dashboard creator.

No recorded changes to this operation across all 4 revisions of this API.