Skip to main content
GET
Search dashboards

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

limit
integer
default:10

Max results to return (1-25).

Required range: x <= 25
Example:

10

q
string
required

Free-text keywords matched against dashboard names, descriptions, and tile titles.

Minimum string length: 1
Example:

"revenue by region"

userId
string<uuid>

Requires an Organization API key. The ID of the user to search as. Results are scoped to what the specified user can access (content permits and model role).

Personal Access Tokens (PATs) can only specify their own membership ID.

Response

Matching dashboards

results
object[]
required

Matching dashboards, most relevant first.