Skip to content

List dashboards.

GET
/dashboards
curl --request GET \
--url 'https://api.siteqwality.com/dashboards?sort=viewed' \
--header 'Authorization: Bearer <token>'

Live dashboards by default, or the ones deleted in the last 30 days with deleted=true. Dashboards deleted longer ago are purged here.

search
string

Matches the name, description or a tag (case-insensitive substring).

tag
string

Only dashboards with this exact tag.

favorites
boolean

Only the caller’s favorites.

mine
boolean

Only dashboards the caller created.

deleted
boolean

The recently deleted list (restorable for 30 days) instead of live boards.

sort
string
Allowed values: viewed updated name
limit
integer format: int64

1 to 200, default 50.

offset
integer format: int64

One page of dashboards and the filtered total

Media type application/json
object
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
description
string | null
tags
required
Array<string>
version
required
integer format: int32
locked
required
boolean
template_key
string | null
created_by
One of:

The member who made a change.

object
id
required
string format: uuid
name
string | null
email
required
string
updated_by
One of:

The member who made a change.

object
id
required
string format: uuid
name
string | null
email
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
deleted_at
string | null format: date-time
favorite
required
boolean
can_edit
required
boolean
share_count
required
integer format: int64
widget_count
required

Widgets including the members of collapsed sections, sections excluded.

integer format: int64
last_viewed_at

The caller’s last visit; null for API keys and unvisited boards.

string | null format: date-time
view_count
required
integer format: int32
total
required
integer format: int64
Example generated
{
"items": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"description": "example",
"tags": [
"example"
],
"version": 1,
"locked": true,
"template_key": "example",
"created_by": {
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"email": "example"
},
"updated_by": {
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"email": "example"
},
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z",
"deleted_at": "2026-04-15T12:00:00Z",
"favorite": true,
"can_edit": true,
"share_count": 1,
"widget_count": 1,
"last_viewed_at": "2026-04-15T12:00:00Z",
"view_count": 1
}
],
"total": 1
}

Invalid filters

Missing or invalid authentication

Internal server error