Sign in
dashboards

Create Category

Create a user tab (ADMIN). Slug is generated from the name and immutable.

Auto-grants the creator a can_edit access row: redundant for authorization (admins always retain access) but load-bearing for nav display, which renders granted + everyone tabs.

post/api/v1/dashboards/dashboard-categories

Request body

namestring required
iconstring nullable
visibility'everyone' | 'granted_only'

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.

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.