list_dashboards

List saved dashboards for a Bridge Town model. Requires at least Viewer access to the model.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model whose dashboards to list.')]	Yes	—
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

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

See the response example below for the full payload shape.

Example

Tool Call

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

Response

{
  "model": "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.