Skip to main content
POST
/
api
/
v2
/
workspace
/
dashboards
Fetch Dashboards by Workspace (Legacy)
curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace/dashboards \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workspaceName": "<string>",
  "isPagination": true,
  "pageNumber": 123
}'
{
  "data": [
    {
      "name": "string",
      "externalDashboardId": "string"
    }
  ],
  "error": null
}
Legacy Endpoint - Deprecated: This endpoint is deprecated and will be removed in a future release. Please use the Fetch Dashboards by Data App endpoint instead, which provides enhanced functionality and uses the /api/v2/data-app/dashboards path.
Retrieve a list of dashboards available in a workspace. This is a legacy endpoint maintained for backward compatibility.

​
Cloud Databrain Endpoint

POST https://api.usedatabrain.com/api/v2/workspace/dashboards

​
Self-hosted Databrain Endpoint

POST <SELF_HOSTED_URL>/api/v2/workspace/dashboards

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
Request Body

​
workspaceName
string
required
​
isPagination
boolean
​
pageNumber
number
{
  "data": [
    {
      "name": "string",
      "externalDashboardId": "string"
    }
  ],
  "error": null
}

​
Error Codes

  • INVALID_REQUEST_BODY: The request body is invalid.
  • WORKSPACE_ID_ERROR: The workspace name provided does not exist.

​
Validation Schema

The request body must conform to the following schema:
  • workspaceName (required): Name of the workspace.
  • isPagination (optional): Boolean flag to enable pagination.
  • pageNumber (optional): Page number when pagination is enabled.

​
Migration Guide

Recommended Migration: Switch to the Fetch Dashboards by Data App endpoint for better performance and additional features.

​
Key Differences:

Legacy (Workspace)New (Data App)
Uses workspaceNameUses data app API token
POST with body parametersGET or POST methods available
Limited filteringAdvanced filtering by dashboard names
Workspace-level accessData app-level access with better multi-tenancy

​
Migration Example:

Before (Legacy): 
POST /api/v2/workspace/dashboards
{
  "workspaceName": "my-workspace",
  "isPagination": true,
  "pageNumber": 1
}
After (Recommended): 
GET /api/v2/data-app/dashboards?isPagination=true&pageNumber=1
Authorization: Bearer dbn_live_abc123...
See the Fetch Dashboards by Data App documentation for complete migration details.
⌘I