Skip to main content
GET
/
api
/
workspace
/
{workspaceId}
/
dashboards
List dashboards
curl --request GET \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/dashboards \
  --header 'Authorization: Bearer <token>'
{
  "dashboards": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "layout": {
        "version": 1,
        "cols": 24,
        "rowHeight": 136
      },
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Headers

​
X-Active-Brand
string<uuid>

Brand context (uuid). When omitted, the ?brand_id query parameter is used.

Path Parameters

​
workspaceId
string
required

The workspace ID

Pattern: ^ws_[a-z0-9]+$

Query Parameters

​
brand_id
string<uuid>

Brand context (uuid). Fallback for callers that cannot send headers.

Response

Dashboards in the active brand

​
dashboards
object[]
required
Last modified on April 25, 2026