list_dashboards

List saved dashboards for a Bridge Town model and return each rendered dashboard’s authenticated app URL for the current authorized caller. 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	—
limit	Annotated[int, Field(ge=1, le=200, description='Maximum dashboards per page (default 50).')]	No	50
cursor	`Annotated[str	None, Field(description=‘Opaque continuation cursor from a previous list_dashboards response.’)]`	No	None
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)
• total_count (integer)
• truncated (boolean)
• workspace_id (string)

See the response example below for the full payload shape.

Example

Tool Call

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

Response

{
  "model": "forecasts",
  "dashboards": [
    {
      "dashboard_id": "77777777-7777-7777-7777-777777777777",
      "name": "ARR Bridge",
      "description": "Annual recurring revenue waterfall",
      "dashboard_url": "https://app.bridgetown.builders/dashboards/77777777-7777-7777-7777-777777777777",
      "open_hint": "Open dashboard_url as the current authorized caller. This read-only URL does not grant or revoke team access; use manage_dashboard_share only for an explicit sharing change.",
      "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",
      "provenance": {
        "source_kind": "run",
        "model_name": "forecasts",
        "run_id": "b0c17bd7-044f-4d7b-82af-36fd067f03dc",
        "branch": "main",
        "commit_sha": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "source_path": null,
        "materialized_at": "2026-04-28T10:00:00+00:00",
        "revision_id": null,
        "revision_number": null,
        "content_hash": null
      },
      "run_state": "stale",
      "latest_run_id": "3aa1b2b0-f2cf-4205-b8f7-c6eed44df72e",
      "latest_commit_sha": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      "run_state_reason": "superseded_by_latest_successful_run"
    }
  ],
  "count": 1,
  "total_count": 1,
  "truncated": false,
  "workspace_id": "8a807af4-93a2-4f6f-b09f-c44ac7e665d9"
}

Notes

• Module: Dashboards
• Requires an authenticated Bridge Town session (OAuth) or an API token.