> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.labric.co/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.labric.co/_mcp/server.

# List dashboards

GET https://platform.labric.co/api/v1/dashboards

Lists the organization's dashboards, filtered by publish status or
author if given. Items are omitted. Get a dashboard to see its items.

Requires an API key with the `read` scope.

Reference: https://docs.labric.co/api-reference/labric-api/dashboards/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `publish_status` (enum, optional, nullable) — Whether an authored object is finished enough for others to rely on. In review marks a draft its author considers ready for an admin to publish.
  - Allowed values: `draft`, `in_review`, `published`
- `user_id` (string, optional, nullable)

## Response

### 200

OK

- `list of DashboardSchema`

## Errors

### 400 Bad Request Error

Bad Request

- `detail` (string, required)

### 401 Unauthorized Error

Unauthorized

- `detail` (string, required)

### 403 Forbidden Error

Forbidden

- `detail` (string, required)

### 404 Not Found Error

Not Found

- `detail` (string, required)

### 422 Unprocessable Entity Error

Unprocessable Content

- `detail` (list of map from string to any, required)

### 500 Internal Server Error

Internal Server Error

- `detail` (string, required)

## Types

### DashboardSchema

- `id` (string, required)
- `name` (string, required)
- `publish_status` (enum, required) — Whether an authored object is finished enough for others to rely on. In review marks a draft its author considers ready for an admin to publish.
  - Allowed values: `draft`, `in_review`, `published`
- `date_updated` (datetime, required)
- `description` (string, optional, nullable)
- `items` (list of DashboardItemSchema, optional, nullable)
- `user` (UserSchema, optional, nullable)
- `access_level` (enum, optional, nullable) — What a grant lets its grantee do. Manage includes edit and adds sharing, archiving and deleting.
  - Allowed values: `edit`, `manage`

### DashboardItemSchema

- `id` (string, required)
- `category` (enum, required)
  - Allowed values: `visualization`, `text`, `widget`
- `position_x` (integer, required)
- `position_y` (integer, required)
- `size_x` (integer, required)
- `size_y` (integer, required)
- `description` (string, optional, nullable)
- `visualization` (VisualizationSchema, optional, nullable)
- `specification` (map from string to any, optional, nullable)

### UserSchema

- `clerk_id` (string, required)
- `email` (string, required)
- `first_name` (string, optional, nullable)
- `last_name` (string, optional, nullable)
- `image_url` (string, optional, nullable)

### VisualizationSchema

- `id` (string, required)
- `name` (string, required)
- `publish_status` (enum, required) — Whether an authored object is finished enough for others to rely on. In review marks a draft its author considers ready for an admin to publish.
  - Allowed values: `draft`, `in_review`, `published`
- `date_updated` (datetime, required)
- `description` (string, optional, nullable)
- `dataset` (DatasetSchema, optional, nullable)
- `specification` (map from string to any, optional, nullable)
- `user` (UserSchema, optional, nullable)
- `access_level` (enum, optional, nullable) — What a grant lets its grantee do. Manage includes edit and adds sharing, archiving and deleting.
  - Allowed values: `edit`, `manage`

### DatasetSchema

- `id` (string, required)
- `name` (string, required)
- `publish_status` (enum, required) — Whether an authored object is finished enough for others to rely on. In review marks a draft its author considers ready for an admin to publish.
  - Allowed values: `draft`, `in_review`, `published`
- `date_updated` (datetime, required)
- `description` (string, optional, nullable)
- `query` (string, optional, nullable)
- `default_parameters` (map from string to any, optional, nullable)
- `user` (UserSchema, optional, nullable)
- `access_level` (enum, optional, nullable) — What a grant lets its grantee do. Manage includes edit and adds sharing, archiving and deleting.
  - Allowed values: `edit`, `manage`

## Examples

**Response**

```json
[
  {
    "id": "string",
    "name": "string",
    "publish_status": "draft",
    "date_updated": "2024-01-15T09:30:00Z",
    "description": "string",
    "items": [
      {
        "id": "string",
        "category": "visualization",
        "position_x": 1,
        "position_y": 1,
        "size_x": 1,
        "size_y": 1,
        "description": "string",
        "visualization": {
          "id": "string",
          "name": "string",
          "publish_status": "draft",
          "date_updated": "2024-01-15T09:30:00Z",
          "description": "string",
          "dataset": {
            "id": "string",
            "name": "string",
            "publish_status": "draft",
            "date_updated": "2024-01-15T09:30:00Z",
            "description": "string",
            "query": "string",
            "default_parameters": {},
            "user": {
              "clerk_id": "string",
              "email": "string",
              "first_name": "string",
              "last_name": "string",
              "image_url": "string"
            },
            "access_level": "edit"
          },
          "specification": {},
          "user": {
            "clerk_id": "string",
            "email": "string",
            "first_name": "string",
            "last_name": "string",
            "image_url": "string"
          },
          "access_level": "edit"
        },
        "specification": {}
      }
    ],
    "user": {
      "clerk_id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "image_url": "string"
    },
    "access_level": "edit"
  }
]
```

**SDK Code**

```python
import requests

url = "https://platform.labric.co/api/v1/dashboards"

headers = {"Authorization": "Bearer <api_key>"}

response = requests.get(url, headers=headers)

print(response.json())
```