Skip to main content
GET
List dashboard sections

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
tenant
string
tenant[]
string[]
layoutType
string
layoutType[]
string[]
isActive
boolean
isCollapsed
boolean
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[position]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc

Response

200 - application/json

DashboardCategory collection

id
integer
read-only
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

name
string | null
layoutType
string
placement
(string | null)[]
layout
(string | null)[] | null
widgets
string<iri-reference>[]
Example:
position
integer
default:0
isActive
boolean
default:true
isCollapsed
boolean
default:false
dateCreated
string<date-time>
dateUpdated
string<date-time>
fullWidth
boolean
read-only
systemCategory
boolean
read-only
configuration
(string | null)[]
read-only