Skip to main content
POST
Search dashboards

Restrictions

Usage

  • query must contain at least one word; an empty or whitespace-only query fails with InvalidParameter. A dashboard matches when every word appears as a substring of its title or description.
  • Reading is open to every member of the account. scope picks what the search covers: mine is the folders of your teams and the folders you created, plus their descendants; all is every folder of the account. When scope is omitted, account owners, admins and roles with the all-teams view scope get all; other members get mine. Trashed dashboards are never returned.
  • Sort keys are title and updated_at, at most two and each used once; the default is updated_at descending.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Search dashboards across every folder the caller can read. The query must contain at least one word.

query
string
required

Search words separated by whitespace; at least one word and at most 128 Unicode code points. A dashboard matches when every word appears in its title or description.

Required string length: 1 - 128
scope
enum<string>

Which folders the response covers. mine covers the folders of the caller's teams and the folders the caller created, plus their descendants; all covers every folder of the account. When omitted, it is all for account owners, admins and roles with the all-teams view scope, and mine for other members. Any other value fails with InvalidParameter.

Available options:
mine,
all
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

A page of dashboards plus the total matching count.