v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB

Report

Get Available Widgets

Retrieves a list of available dashboard widgets, optionally filtered by the screen type ID.

get/v1/dashboard/widgets

Query parameters

screenTypeIdinteger

The unique identifier of the screen type to filter the widgets.

Response

A list of widgets was successfully retrieved.

WidgetTypeIdinteger

The unique identifier for the type of widget.

WidgetNamestring nullable

The display name of the widget.

{"stackTrail":"components:schemas:WidgetResponseDto:properties:WidgetConfig","oasType":"schema","type":"unknown","description":"A JSON object containing specific configuration settings for the widget UI.","nullable":true}

Categoriesinteger[] nullable

A list of group IDs that have permission to view or manage this widget.

Groupsinteger[] nullable