Skip to main content
POST
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:
  1. In Settings page, navigate to the Service Tokens section.
  2. Click the “Generate Token” button to create a new service token if you don’t have one already.
Use this token as the Bearer value in your Authorization header.

Headers

string
required
Bearer token for API authentication. Use your service token.
string
required
Must be set to application/json for all requests.

Request Body

string
required
Name of the workspace to fetch dashboards from. Must match an existing workspace in your organization.
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
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

array
Array of dashboard objects. Returns empty array if no dashboards exist or page number exceeds available pages.
null | object
Error object if the request failed, otherwise null for successful requests.

Examples

HTTP Status Code Summary

Possible Errors

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