Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • shared: When eq(shared,true), returns the organisation's shared dashboards (requires eq(organisation,<id>)) instead of the caller's own.
  • organisation: Filter by organisation ID. Required alongside eq(shared,true).
  • scope: Filter by surface (e.g. landing, organisation-root).

For more information on using named filters, see the docs

Response

Get a list of the current user's dashboards.

JSON API response object

data
A list of dashboards · object[]
required
meta
object
required
jsonapi
object
required