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, share_expires_at, has_html, created_at, updated_at}]) — one entry per dashboard; is_shared reflects only currently-active shares (false when expired); share_expires_at is the ISO-8601 UTC expiry timestamp, or null for no-expiry shares; count (int) — number of dashboards.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
project_name	Annotated[str, Field(description='Name of the Bridge Town project whose dashboards to list.')]	Yes	—

Returns

Returns a structured object. Top-level fields:

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

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "list_dashboards",
  "arguments": {
    "project_name": "forecasts"
  }
}

Response

{
  "project": "forecasts",
  "dashboards": [
    {
      "name": "ARR Bridge",
      "description": "Annual recurring revenue waterfall",
      "is_shared": true,
      "share_expires_at": "2026-03-31T10:00:00+00:00",
      "has_html": true,
      "created_at": "2026-04-28T10:00:00+00:00",
      "updated_at": "2026-04-28T10:00:00+00:00"
    }
  ],
  "count": 1
}

Notes

• Module: Dashboards
• Requires authentication via API token or Auth0 JWT.