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

# spreadsheets_get

> Get spreadsheet metadata and structure.

<div className="tool-route"><span className="tool-row-method" data-method="GET">GET</span><code>{"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}"}</code></div>

```python gsheets_spreadsheets_get.py theme={null}
from charter.packs import gsheets

result = await gsheets.spreadsheets_get.ainvoke({"spreadsheetId": ...})
```

<Note>
  Requires `https://www.googleapis.com/auth/spreadsheets`. Costs 1 against the provider's own quota.
</Note>

## Path parameters

<div className="reference-table">
  | Field                                                                 | Type     | Description                 |
  | --------------------------------------------------------------------- | -------- | --------------------------- |
  | `spreadsheetId` <span className="required" title="required">\*</span> | `string` | The spreadsheet to request. |
</div>

## Query parameters

<div className="reference-table">
  | Field                         | Type        | Description                                                                                             |
  | ----------------------------- | ----------- | ------------------------------------------------------------------------------------------------------- |
  | `ranges`                      | `string`\[] | The ranges to retrieve from the spreadsheet.                                                            |
  | `includeGridData`             | `boolean`   | True if grid data should be returned. This parameter is ignored if a field mask was set in the request. |
  | `excludeTablesInBandedRanges` | `boolean`   | True if tables should be excluded in the banded ranges. False if not set.                               |
</div>