Skip to main content
POST
List dashboards

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

List the dashboards in one folder. Unlike search, folder_id is required.

folder_id
integer<uint64>
required

Folder whose dashboards are listed.

Required range: x >= 1
query
string

Optional space-separated search words matched against title and description; at most 128 Unicode code points.

Maximum string length: 128
sort
object[]

Sort keys; defaults to updated_at descending.

Maximum array length: 2
p
integer

Page number, 1-based. Defaults to 1.

Required range: x >= 1
limit
integer

Page size, 1–100. Defaults to 20.

Required range: 1 <= x <= 100

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

A page of dashboards plus the total matching count.