> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Dashboards

> List all dashboards for your organization, including shared parent dashboards

# List Dashboards

Retrieve all dashboards for the current organization. If your organization is a child in a group hierarchy, dashboards shared by parent organizations are also included.

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

## Response

Returns a list of dashboard objects with HTTP 200. Each item contains:

<ResponseField name="id" type="string">
  Dashboard UUID
</ResponseField>

<ResponseField name="project_id" type="string">
  UUID of the project this dashboard belongs to
</ResponseField>

<ResponseField name="widgets" type="array">
  List of widget configurations

  <Expandable title="Widget object">
    <ResponseField name="id" type="string">Widget identifier</ResponseField>
    <ResponseField name="name" type="string">Widget display name</ResponseField>
    <ResponseField name="type" type="string">Chart type (e.g. `bar_chart`, `line_chart`, `pie_chart`, `table`)</ResponseField>
    <ResponseField name="tab_id" type="string">Tab this widget belongs to</ResponseField>
    <ResponseField name="config" type="object">Widget configuration with metrics, periodicity, periods, and unit</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="layouts" type="object">
  Responsive grid layouts with breakpoints: `lg`, `md`, `sm`, `xs`, `xxs`
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Creation timestamp (ISO 8601)
</ResponseField>

<ResponseField name="updated_at" type="datetime | null">
  Last update timestamp (ISO 8601)
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X GET "https://api.dcycle.io/v2/dashboard" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}"
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
  }

  response = requests.get(
      "https://api.dcycle.io/v2/dashboard",
      headers=headers,
  )

  dashboards = response.json()
  for d in dashboards:
      print(f"Dashboard {d['id']} — project: {d['project_id']}, widgets: {len(d['widgets'])}")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
  };

  axios.get('https://api.dcycle.io/v2/dashboard', { headers })
    .then(response => {
      response.data.forEach(d =>
        console.log(`Dashboard ${d.id} — ${d.widgets.length} widgets`)
      );
    });
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "project_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
    "widgets": [
      {
        "id": "widget-1",
        "name": "Carbon Footprint by Scope",
        "type": "bar_chart",
        "config": { ... }
      }
    ],
    "layouts": {
      "lg": [{ "i": "widget-1", "x": 0, "y": 0, "w": 6, "h": 4 }],
      "md": [],
      "sm": [],
      "xs": [],
      "xxs": []
    },
    "created_at": "2024-11-24T10:30:00Z",
    "updated_at": "2024-12-15T14:20:00Z"
  }
]
```

## Response Fields

| Field        | Type     | Description                            |
| ------------ | -------- | -------------------------------------- |
| `id`         | UUID     | Dashboard identifier                   |
| `project_id` | UUID     | Associated project                     |
| `widgets`    | array    | List of widget configurations          |
| `layouts`    | object   | Responsive grid layouts per breakpoint |
| `created_at` | datetime | Creation timestamp                     |
| `updated_at` | datetime | Last modification timestamp            |

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

**Cause:** The authenticated user is not a member of the organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Get Dashboard" icon="chart-mixed" href="/api-reference/dashboards/get">
    Get a specific dashboard by ID
  </Card>

  <Card title="Create Dashboard" icon="plus" href="/api-reference/dashboards/create">
    Create a new dashboard
  </Card>
</CardGroup>