> ## 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.

# Get Dashboard

> Retrieve a specific dashboard with its widgets and layouts

# Get Dashboard

Retrieve a specific dashboard by its ID, including all widgets and responsive grid layouts.

## 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>

### Path Parameters

<ParamField path="dashboard_id" type="string" required>
  UUID of the dashboard

  **Example:** `"550e8400-e29b-41d4-a716-446655440000"`
</ParamField>

## Response

Returns the dashboard object with HTTP 200.

<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`. Each contains an array of layout items with `i` (widget ID), `x`, `y`, `w`, `h` grid positions.
</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/550e8400-e29b-41d4-a716-446655440000" \
    -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"),
  }

  dashboard_id = "550e8400-e29b-41d4-a716-446655440000"
  response = requests.get(
      f"https://api.dcycle.io/v2/dashboard/{dashboard_id}",
      headers=headers,
  )

  dashboard = response.json()
  print(f"Project: {dashboard['project_id']}")
  print(f"Widgets: {len(dashboard['widgets'])}")
  for widget in dashboard["widgets"]:
      print(f"  - {widget['name']} ({widget['type']})")
  ```

  ```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,
  };

  const dashboardId = '550e8400-e29b-41d4-a716-446655440000';

  axios.get(`https://api.dcycle.io/v2/dashboard/${dashboardId}`, { headers })
    .then(response => {
      const { project_id, widgets } = response.data;
      console.log(`Project: ${project_id}, Widgets: ${widgets.length}`);
    });
  ```
</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",
      "tab_id": "tab-general",
      "config": {
        "metrics": [
          {
            "id": "metric-1",
            "category": "emissions",
            "filters": [{ "type": "scope", "field": "scope", "value": "1" }],
            "aggregation": {
              "organizations": [{ "id": "org-uuid" }]
            }
          }
        ],
        "periodicity": "monthly",
        "periods": [{ "start_date": "2024-01-01", "end_date": "2024-12-31" }],
        "unit": "tCO2e"
      }
    }
  ],
  "layouts": {
    "lg": [{ "i": "widget-1", "x": 0, "y": 0, "w": 6, "h": 4 }],
    "md": [{ "i": "widget-1", "x": 0, "y": 0, "w": 6, "h": 4 }],
    "sm": [{ "i": "widget-1", "x": 0, "y": 0, "w": 4, "h": 4 }],
    "xs": [{ "i": "widget-1", "x": 0, "y": 0, "w": 2, "h": 4 }],
    "xxs": [{ "i": "widget-1", "x": 0, "y": 0, "w": 1, "h": 4 }]
  },
  "created_at": "2024-11-24T10:30:00Z",
  "updated_at": "2024-12-15T14:20:00Z"
}
```

## 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"}
```

### 404 Not Found

**Cause:** Dashboard does not exist or does not belong to your organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": "Not found."
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Update Dashboard" icon="pencil" href="/api-reference/dashboards/update">
    Modify dashboard widgets and layouts
  </Card>

  <Card title="List Dashboards" icon="table-columns" href="/api-reference/dashboards/list">
    View all dashboards
  </Card>
</CardGroup>