Method: spreadsheets.get

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.

By default, data within grids will not be returned. You can include grid data one of two 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

HTTP request

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
spreadsheetId

string

The spreadsheet to request.

Query parameters

Parameters
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.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Spreadsheet.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

For more information, see the Auth Guide.

Send feedback about...