Sign in
dashboards

List Categories

List the tenant's tabs, system tabs first, then by sort order.

Nav display (default) shows everyone + granted tabs — the same set for members and admins (admins auto-grant themselves on create). all_tabs is the admin-only "show all tabs" escape hatch (design §3: nav vs access are separate concerns).

get/api/v1/dashboards/dashboard-categories

Query parameters

all_tabsboolean

Response

Successful Response

idstring uuid required
namestring required
slugstring required
iconstring nullable
page_headingstring nullable
descriptionstring nullable
is_visibleboolean
sort_orderinteger required
is_systemboolean required
visibility'everyone' | 'granted_only' required

Who can see a DashboardCategory (tab).

  • everyone: every tenant member sees the tab (the default for the system tabs we ship).
  • granted_only: ADMINs + users listed in DashboardCategoryAccess. The default for newly created tabs so a half-built tab never appears in the chairman's nav before an admin grants it. Named granted_only (not restricted): it is never restricted from admins.
created_by_user_idstring uuid nullable
can_editboolean
created_atstring date-time required
updated_atstring date-time required
domainsstring[] required

The data domain(s) this tab exposes, from its slug. Drives which global filter dimensions the panel renders for the tab.

Changes

No recorded changes to this endpoint across all 1 revision of this API.