get_sheet_metadata
Get the spreadsheet's metadata: title, locale, time zone and every tab's properties.
readGoogle Sheets, Docs & Drive
For tab names and sheetIds only, list_sheet_tabs is much smaller.
Call it
In an AI client (MCP)
{
"name": "get_sheet_metadata",
"arguments": {
"spreadsheet_id": "<spreadsheet_id>"
}
}From code (Tool API)
curl -X POST https://api.sellersheetai.com/api/v1/tools/get_sheet_metadata \
-H "Authorization: Bearer $SELLERSHEET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spreadsheet_id":"<spreadsheet_id>"}'Early access — the Tool API is open on request, contact us.
Arguments
| Name | Type | Description |
|---|---|---|
spreadsheet_idrequired | string | the spreadsheet ID (from its URL or get_sheet_metadata). |
Result
Every tool answers {notification, data, human_action}; data carries:
data.properties— title, locale, timeZone.data.sheets[]— each tab's properties (sheetId, title, index, gridProperties rowCount / columnCount / frozenRowCount) plus its protectedRanges, merges, basicFilter, charts and conditionalFormats.data.namedRanges[] / data.spreadsheetUrl— the named ranges and the URL.
Gotchas
- The spreadsheet must be shared with SellerSheet's Google service account as Editor (workbooks set up by the SellerSheet sidebar already are); a permission error means the user has to share it.
Example
get_sheet_metadata("1ABC...")