Skip to content

get_google_spreadsheet_metadata

Get a connected Google Sheet’s title, tabs, and dimensions.

read-only · idempotent

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
spreadsheet_id`Annotated[strNone, Field(description=‘Google Spreadsheet ID from the sheet URL.’)]`NoNone
source_name`Annotated[strNone, Field(description=‘Logical name of the connected Google Sheet data source.’)]`NoNone
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • spreadsheet_id (string)
  • title (string)
  • sheets (array<object>)

See the response example below for the full payload shape.

{
"name": "get_google_spreadsheet_metadata",
"arguments": {
"model_name": "forecasts",
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG"
}
}
{
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"title": "FY26 Forecast",
"sheets": [
{
"sheetId": 0,
"title": "Forecast",
"index": 0
}
]
}
  • Module: Google Sheets
  • Requires authentication via API token or Auth0 JWT.