# List dashboards

> Source: https://elaichi.ai/docs/api-reference/dashboards/dashboard/listdashboards/

`GET /dashboard`

Resource: **Dashboard** · API: **Dashboards**

## Query parameters

- **`q`** _(string)_
  Substring match on the dashboard's name or description. LIKE wildcards are matched literally. Max 200 characters.
- **`manageable`** _(boolean)_
  Only dashboards the caller may edit. Applied in the query before paging, so a page is never empty while a later one is not.

## Response body

- **`result`** _(array<object>)_
  - **`id`** _(string)_
  - **`owner_user_id`** _(string)_
  - **`name`** _(string)_
  - **`description`** _(string)_
  - **`revision`** _(integer)_
  - **`page_count`** _(integer)_
  - **`widget_count`** _(integer)_
  - **`source_summary`** _(object)_
    - **`collection_ids`** _(array<string>)_
    - **`toolbox_ids`** _(array<string>)_
  - **`created_at`** _(string)_
  - **`updated_at`** _(string)_
  - **`updated_by`** _(string,null)_
  - **`can_share`** _(boolean)_
  - **`can_manage`** _(boolean)_
  - **`can_transfer`** _(boolean)_
  - **`can_revoke_share`** _(boolean)_
  - **`can_see_shares`** _(boolean)_
  - **`owner_display_name`** _(string,null)_
  - **`owner_avatar_url`** _(string,null)_
    The person's picture: their stored profile picture, else a Gravatar URL (`d=404`, 96px) derived from their email (the address itself is not sent), else null. Draw initials when it is null or the image fails to load.
  - **`access_via`** _(string)_
  - **`access_summary`** _(unknown)_
  - **`status`** _(string)_
    draft_only: never published, so only editors can open it. published_with_changes: live, with a pending draft.
    Allowed: `published`, `draft_only`, `published_with_changes`
  - **`ever_published`** _(boolean)_
  - **`has_draft`** _(boolean)_
    A pending draft exists. Only a caller with `can_manage` is ever shown the draft itself.
  - **`live_changed_since_draft`** _(boolean)_
    The live dashboard was saved after the pending draft began, so publishing would replace that save. Only ever true for a caller with `can_manage`; the Elaichi app warns in words and sends `live_revision` on publish only after the person confirms.
  - **`draft_revision`** _(integer)_
    The guard on `PUT /dashboard/{id}/draft`. Moves on every draft save, publish and discard.
  - **`updated_via`** _(string,null)_
    How the last edit was made; null for edits that predate the draft layer.
    Allowed: `console`, `agent`, `mcp`, `api`, `null`
  - **`updated_client`** _(string,null)_
    The connected AI client's display name ("Claude") when `updated_via` is `mcp`; null when that client is unknown. Never an internal id.
  - **`source_preview`** _(array<object>)_
    At most three sources the caller can read. The total is `source_summary`; the full set is `sources` on the detail.
    - **`name`** _(string)_
    - **`resource_type`** _(string)_
      Allowed: `collection`, `toolbox`, `automation`
    - **`slug`** _(string,null)_
      The connector slug when the source has exactly one; null otherwise, never guessed.
    - **`logo`** _(string,null)_
- **`next_cursor`** _(string,null)_
- **`prev_cursor`** _(string,null)_

## Code examples

### curl

```bash
curl -X GET 'https://api.elaichi.ai/dashboard' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json'
```

### JavaScript

```javascript
const response = await fetch('https://api.elaichi.ai/dashboard', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Python

```python
import os
import requests

url = "https://api.elaichi.ai/dashboard"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```