> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/widget-types.md).

# Widget Types

Administrative endpoints for **widget types** — the type definitions that give CMS widgets their structure. Each widget type carries a unique name and a JSON schema; the schema describes the attributes that widgets of that type can carry and is used by the management panel to render the widget's edit form.

### Core Capabilities

**1. Widget Type Listing & Filtering**

* Retrieve a paginated list of widget types.
* Filter by name (case-insensitive contains).

**2. Widget Type Lifecycle Management**

* Create a widget type with a unique name and a JSON schema.
* Retrieve, fully or partially update, or permanently delete a widget type.

### Deletion Behavior

Deleting a widget type is a **hard delete** — the record is permanently removed from the database, along with all widgets that belong to that type (cascade delete via the `widget_type` foreign key on widgets). Verify that no widgets reference the type before deleting it.

### Dynamic Settings & Environment Variables

No dynamic settings (`dj_dynamic_settings`) and no environment variables affect these endpoints. Listing, creation, update, and deletion behave identically regardless of management-panel configuration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/widget-types.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
