> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Get spreadsheet

> Retrieve Google spreadsheet, sheet, named-range, and native-table metadata.

`getSpreadsheet` loads metadata without grid cell values. Use it to discover
immutable sheet and table IDs or inspect spreadsheet settings.

## Example

```ts theme={null}
import { automation, onHttpRequest } from "automate.ax"
import { getSpreadsheet } from "automate.ax/google-sheets"

export default automation("Inspect a workbook", () => {
  onHttpRequest({ scope: "automation" })

  getSpreadsheet({
    spreadsheet: "https://docs.google.com/spreadsheets/d/id/edit",
  })
})
```

## Inputs

`spreadsheet: string` is required. `account` optionally selects the Google
account; all action inputs accept compatible signals.

## Output

Returns a `Spreadsheet` with `spreadsheetId`, `title`, `url`, optional `locale`,
`timeZone`, and `autoRecalc`, plus `namedRanges` and sheets. Each sheet includes
`sheetId`, `title`, zero-based `index`, `sheetType`, `hidden`, `rightToLeft`,
frozen and allocated row/column counts, and native `tables`. Named and table
ranges use zero-based, end-exclusive `startRowIndex`, `endRowIndex`,
`startColumnIndex`, and `endColumnIndex` with `sheetId`.