Fetch Dashboards by Workspace

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace/dashboards \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspaceName": "my-workspace"
  }'

{
  "data": [
    {
      "name": "Sales Dashboard",
      "externalDashboardId": "sales_dash_123"
    },
    {
      "name": "Marketing Analytics",
      "externalDashboardId": "marketing_dash_456"
    }
  ],
  "error": null
}

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace/dashboards \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspaceName": "my-workspace"
  }'

{
  "data": [
    {
      "name": "Sales Dashboard",
      "externalDashboardId": "sales_dash_123"
    },
    {
      "name": "Marketing Analytics",
      "externalDashboardId": "marketing_dash_456"
    }
  ],
  "error": null
}

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace/dashboards \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspaceName": "my-workspace"
  }'

{
  "data": [
    {
      "name": "Sales Dashboard",
      "externalDashboardId": "sales_dash_123"
    },
    {
      "name": "Marketing Analytics",
      "externalDashboardId": "marketing_dash_456"
    }
  ],
  "error": null
}

POST

api

workspace

dashboards

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/workspace/dashboards \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspaceName": "my-workspace"
  }'

{
  "data": [
    {
      "name": "Sales Dashboard",
      "externalDashboardId": "sales_dash_123"
    },
    {
      "name": "Marketing Analytics",
      "externalDashboardId": "marketing_dash_456"
    }
  ],
  "error": null
}

Retrieve a list of dashboards available in a workspace. Use this endpoint to discover dashboards for provisioning and embedding in your application.

This endpoint operates at the workspace level using a service token. Use the workspace name to scope which dashboards are returned. Supports pagination for workspaces with many dashboards.

Authentication

This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:

Go to your Databrain dashboard and open Settings.
Navigate to Settings.
Find the Service Tokens section.
Click the “Generate Token” button to generate a new service token if you don’t have one already.

Use this token as the Bearer value in your Authorization header.

Headers

Authorization

string

required

Bearer token for API authentication. Use your service token.

Authorization: Bearer dbn_live_abc123...

Content-Type

string

required

Must be set to application/json for all requests.

Content-Type: application/json

Request Body

workspaceName

string

required

Name of the workspace to fetch dashboards from. Must match an existing workspace in your organization.

Show Finding workspace names

Use the List Workspaces endpoint to see all available workspaces
Names are case-sensitive
Must be an exact match

isPagination

boolean

Enable pagination to retrieve dashboards in batches of 10.

true: Enable pagination with page-based retrieval (10 items per page)
false (default): Return all dashboards in a single response

Show When to use pagination

Use pagination when you have more than 20 dashboards in a workspace
Improves response times for large datasets
Each page returns up to 10 dashboards

pageNumber

number

The page number to retrieve when pagination is enabled. Pages are 1-indexed.Note: This parameter is only used when isPagination is set to true.

Response

data

array

Array of dashboard objects. Returns empty array if no dashboards exist or page number exceeds available pages.

Show dashboard object properties

name

string

Display name of the dashboard.

externalDashboardId

string

Unique identifier for the dashboard.

error

null | object

Error object if the request failed, otherwise null for successful requests.

Show error properties

code

string

Error code identifying the type of error.

message

string

Human-readable error message describing what went wrong.

Examples

HTTP Status Code Summary

Status Code	Description
`200`	OK - Dashboards retrieved successfully
`400`	Bad Request - Invalid request parameters
`401`	Unauthorized - Invalid or missing API key
`500`	Internal Server Error - Server error occurred

Possible Errors

Error Code	HTTP Status	Description
`INVALID_REQUEST_BODY`	400	Missing or invalid request body parameters
`WORKSPACE_ID_ERROR`	400	Workspace name does not exist
`INVALID_DATA_APP_API_KEY`	401	Invalid or expired API key
`INTERNAL_SERVER_ERROR`	500	Server error

Next Steps

Fetch Metrics by Workspace

Retrieve metrics from a workspace

List Workspaces

List all workspaces in your organization

Create Workspace

Create a new workspace for your analytics environment

Guest Token API

Generate secure tokens for embedded access

Embedding APIs

Fetch Metrics by Workspace

Authentication

Datasource APIs

Datamart APIs

Workspace APIs

Embeds

Data App APIs

Metric APIs

Self-Hosted APIs

Fetch Dashboards by Workspace

Authentication

Headers

Request Body

Response

Examples

HTTP Status Code Summary

Possible Errors

Next Steps

Fetch Metrics by Workspace

List Workspaces

Create Workspace

Guest Token API

Authentication

Datasource APIs

Datamart APIs

Workspace APIs

Embeds

Data App APIs

Metric APIs

Self-Hosted APIs

​Authentication

​Headers

​Request Body

​Response

​Examples

​HTTP Status Code Summary

​Possible Errors

​Next Steps

Fetch Metrics by Workspace

List Workspaces

Create Workspace

Guest Token API

Authentication

Headers

Request Body

Response

Examples

HTTP Status Code Summary

Possible Errors

Next Steps