Method: spreadsheets.get

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.

HTTP request

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

The URL uses gRPC Transcoding 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.
excludeTablesInBandedRanges

boolean

True if tables should be excluded in the banded ranges. False if not set.

Request body

The request body must be empty.

Response body

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

Authorization scopes

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 Authorization guide.