---
title: "Get Widget Settings"
method: GET
path: "/api/v1/settings/widgets"
tags: ["settings"]
---

# Get Widget Settings

`GET /api/v1/settings/widgets`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/settings/widgets`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

Get current widget configuration settings

## Response `200`

Successful Response

- WidgetSettings: Dashboard widget configuration and preferences
  - `enabled_widgets` string[]
  - `widget_order` object
  - `widget_layout` object
  - `hidden_widgets` string[]
  - `widget_categories_enabled` object

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)