Skip to content

list_dashboards

List saved dashboards for a Bridge Town project. Requires at least Viewer access to the project. Returns: project (str) — project name; dashboards (list[{name, description, is_shared, has_html, created_at, updated_at}]) — one entry per dashboard; count (int) — number of dashboards.

read-only · idempotent

NameTypeRequiredDefaultDescription
project_namestrYes

Returns a structured object. Top-level fields:

  • project (string)
  • dashboards (array<object>)
  • count (integer)

See the response example below for the full payload shape.

{
"name": "list_dashboards",
"arguments": {
"project_name": "forecasts"
}
}
{
"project": "forecasts",
"dashboards": [
{
"name": "ARR Bridge",
"description": "Annual recurring revenue waterfall",
"is_shared": true,
"has_html": true,
"created_at": "2026-04-28T10:00:00+00:00",
"updated_at": "2026-04-28T10:00:00+00:00"
}
],
"count": 1
}
  • Module: Dashboards
  • Requires authentication via API token or Auth0 JWT.