Widgets API
5 endpoints in this group.
GET /api/widgets/visibility
List Visibility
List current user effective widget visibility rows.
Tenant policy is authoritative. Admin-disabled widgets and plan floors are returned as visible=false so client defaults cannot leak them back.
Responses
| Code | Description |
|---|---|
200 | Successful Response |
DELETE /api/widgets/visibility/{widget_id}
Delete Visibility
Drop the user override for widget_id; reverts to registry defaults.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
widget_id | path | string | required |
Responses
| Code | Description |
|---|---|
204 | Successful Response |
422 | Validation Error |
PUT /api/widgets/visibility/{widget_id}
Upsert Visibility
Upsert the user visibility row for widget_id (partial update).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
widget_id | path | string | required |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
PATCH /api/widgets/visibility/{widget_id}/collapsed
Patch Collapsed
Shortcut PATCH for the frontend widgetsApi.setCollapsed client.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
widget_id | path | string | required |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
PATCH /api/widgets/visibility/{widget_id}/position
Patch Position
Shortcut PATCH for the frontend widgetsApi.setPosition client.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
widget_id | path | string | required |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |