# Get a dashboard template

> Source: https://docs.clonepartner.com/api-reference/dashboard-templates/get-dashboard-template/

`GET /api/dashboard-templates/{id}`

Get a dashboard template

**Operation ID:** `getDashboardTemplate`

## Authentication

### Option 1

- **BearerAuth** (`http bearer`)
  API key token. Create via POST /api/api-keys. Format: `envoy_<hex>`

### Option 2

- **CookieAuth** (`apiKey`)
  Session cookie set after login + TOTP verification

## Path parameters

- `id` — `integer`, `required`
  Resource ID

## Success responses

### 200

Dashboard template with parsed definition

**Content type:** `application/json`

- Type: `DashboardTemplate & object`
- All of:
  - Variant 1:
    - Reference: `DashboardTemplate`
      - Type: `object`
      - Properties:
        - `id` (`integer`)
        - `job_template_id` (`integer`)
        - `name` (`string`)
        - `description` (`string | null`)
          - Nullable: yes
        - `yaml_content` (`string`)
        - `status` (`string`)
          - Allowed values: `active`, `archived`
        - `created_at` (`string`)
          - Format: `date-time`
        - `updated_at` (`string | null`)
          - Format: `date-time`
          - Nullable: yes
        - `linked_dashboard_count` (`integer`) — Present on GET detail — count of job dashboards referencing this template
  - Variant 2:
    - Type: `object`
    - Properties:
      - `dashboard` (`object`) — Parsed dashboard definition from yaml_content
      - `linked_dashboard_count` (`integer`)

## Error responses

### 404

Resource not found

**Content type:** `application/json`

- Reference: `Error`
  - Type: `object`
  - Properties:
    - `error` (`string`)
      - Example: `NOT_FOUND`
    - `message` (`string`)
      - Example: `Resource not found`

Example:

```json
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}
```

## Examples

### cURL

```bash
curl --request GET \
  --url 'https://your-envoy.example.com/api/dashboard-templates/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY'
```

### JavaScript (fetch)

```javascript
const response = await fetch('https://your-envoy.example.com/api/dashboard-templates/YOUR_ID', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);
```