Skip to main content

Widget Catalog

GET 
/api/v2/dashboard/widgets

The dashboard widget catalog for the signed-in user — powers the "Add a widget" gallery.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Response fields

  • widgets — the widgets this user may add. A widget is left out when the tenant hides financial data (Settings → Dashboard), when the user lacks the permission for the widget's data (e.g. sales_orders.index), or when the widget shows money and the user lacks financials.index.
  • categories, allowed_widths — gallery groupings and the widths a widget may be resized to.
  • hidden_financial_widgets — {count, reason}: how many money widgets (revenue, inventory value, payables…) were left out because the user lacks the Financials → List permission, and the sentence the gallery shows. count is 0 and reason is null when nothing was withheld.

POs arriving this week stays visible without Financials: it hides only its inbound value per user.

Request​

Responses​

OK

Response Headers
    Content-Type