Skip to main content

Get all dashboards

GET /v2/dashboard

Retrieves a list of all dashboards associated with the authenticated user's tenant. This endpoint provides an overview of all available dashboards, including details such as name, role, status, and timestamps. It is useful for listing dashboards in administrative interfaces or selecting one to view or edit.

Response Example

[
{
"_id": "dashboard-id-1",
"name": "Example Dashboard 1",
"role": "admin",
"roleDisplay": "Administrator",
"tenant": "tenant-id-1",
"status": "inactive",
"sections": [],
"created": "2025-10-29T13:49:41.739Z",
"updated": "2025-10-29T13:49:41.739Z"
},
{
"_id": "dashboard-id-2",
"name": "Example Dashboard 2",
"role": "admin",
"roleDisplay": "Administrator",
"tenant": "tenant-id-1",
"status": "inactive",
"sections": [],
"created": "2025-10-29T13:51:53.062Z",
"updated": "2025-10-29T13:51:53.062Z"
},
{
"_id": "dashboard-id-3",
"name": "Example Dashboard 3",
"role": "admin",
"roleDisplay": "Administrator",
"tenant": "tenant-id-1",
"status": "inactive",
"sections": [],
"created": "2025-10-29T13:52:11.362Z",
"updated": "2025-10-29T13:52:11.362Z"
}
]