POST
/
api
/
v2
/
workspace
/
dashboards
Fetch Dashboards by Workspace
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
}

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
Request Body

​
workspaceName
string
required
​
isPagination
boolean
​
pageNumber
number

​
Response

{
  "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.