# Get dashboard widget

Retrieve the widget configuration for a dashboard.

Source: https://statusdashboard.com/docs/api/status-dashboards/dashboards/widget/get

`GET /app/dashboards/{id}/widget`

Returns the embeddable widget configuration for a dashboard. Also includes the dashboard's `subdomain` and `customDomain` fields needed to generate the widget embed script. Requires the **Widget** feature entitlement.

***

## Path parameters
| Parameter | Description                |
| --------- | -------------------------- |
| `id`      | The UUID of the dashboard. |

***

## Request
See [API Basics](/docs/api) for required headers.

This endpoint takes no request body.

***

## Sample request
```bash
curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/widget \
  -H "Authorization: Bearer bcf847abf5c6:def456"
```

## Sample response
**Status: `200 OK`**

```json
{
  "enabled": true,
  "mode": "badge",
  "title": "System Status",
  "components": [],
  "theme": {
    "primaryColor": "#2d7a7b",
    "backgroundColor": "#ffffff",
    "textColor": "#111827"
  },
  "pollingInterval": 60,
  "subdomain": "acme",
  "customDomain": "status.acme.com",
  "customDomainStatus": "active"
}
```

The `subdomain`, `customDomain`, and `customDomainStatus` fields are included to allow generating the correct widget embed script URL.

***

## Response fields
Same fields as [Update dashboard widget](/docs/api/status-dashboards/dashboards/widget/update#request-body), plus:

| Field                | Type              | Description                                                                                                                                                                                                 |
| -------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `subdomain`          | string            | Dashboard subdomain slug (e.g. `acme`). Included so you can build the widget embed script URL.                                                                                                              |
| `customDomain`       | string \| omitted | Custom domain when configured. Omitted when unset.                                                                                                                                                          |
| `customDomainStatus` | string \| omitted | One of `awaiting_dns`, `validating`, `active`, `removing`, `failed`. Omitted when no custom domain is set. See [Get dashboard domains](/docs/api/status-dashboards/dashboards/domains/get#response-fields). |

***

## Error responses
| Status | When                                                                 |
| ------ | -------------------------------------------------------------------- |
| `403`  | Insufficient permissions, or the Widget feature is not enabled.      |
| `404`  | Dashboard not found or does not belong to the caller's organization. |