Google Sheets Logo

Google Sheets API Integration Profile

Information and guides about integrating with Google Sheets API

Add Google Sheets Integration to Your App

Sheets Spreadsheets Get in Google Sheets API

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a field mask listing your desired fields using the fields URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the includeGridData parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using A1 notation. You can define a single cell (for example, A1) or multiple cells (for example, A1:D5). You can also get cells from other sheets within the same spreadsheet (for example, Sheet2!A1:C4) or retrieve multiple ranges at once (for example, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.

Input schema fields

Field NameAPI KeyType
Path ParameterspathParametersobject
Spreadsheet IdpathParameters.spreadsheetIdstring
Queryqueryobject
Access Tokenquery.access_tokenstring
Altquery.altstring

Output schema fields

Field NameAPI KeyTypeDescription
Spreadsheet IdspreadsheetIdstringThe ID of the spreadsheet. This field is read-only.
PropertiespropertiesobjectProperties of a spreadsheet.
Titleproperties.titlestringThe title of the spreadsheet.
Localeproperties.localestringThe locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported.
Auto Recalcproperties.autoRecalcstringThe amount of time to wait before volatile functions are recalculated.

Supercharge your product integrations today