Return data from a region#

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

Description#

Returns all data from a region, paging if necessary.

When paging, the revision parameter must be set and the per_page parameter indicates the maximum number of cells to include in a single response. The server enforces a maximum per_page of 50,000. An unbounded region may only be used to obtain the first page of results. Use the paged_region or next_url from the first page to retrieve subsequent pages. All cells in the requested region will appear exactly once during the paging process, however ordering is not guaranteed.

GET /spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/data/{region}

Required OAuth Scopes

data_tables|r

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
spreadsheetId	path	string	true	The unique identifier of the spreadsheet
sheetId	path	string	true	The unique identifier of the sheet
region	path	string	true	A1 style representation of a cell or range. A range may be unbounded in any/all directions by leaving off the corresponding column or row. Unbounded ranges will be clamped to the data in the queried region.
value_style	query	string	false	The style of cell value to return.
revision	query	integer(int32)	false	The spreadsheet revision from which to select data. If no revision is provided, the latest revision will be selected.
page	query	integer(int32)	false	The page of results to return.
per_page	query	integer(int32)	false	The number of items to return per page. Leave blank for no limit, returning all results.

Detailed descriptions#

region: A1 style representation of a cell or range. A range may be unbounded in any/all directions by leaving off the corresponding column or row. Unbounded ranges will be clamped to the data in the queried region.

Cell Syntax: [Column][Row]

Range Syntax: [Start Column][Start Row]:[Stop Column][Stop Row]

Examples:

The region A1 selects data in the cell A1
The region A2:D8 selects all data in the range between A2 and D8 (inclusive)
The region A:A selects all data in column A
The region 1:3 selects all data in rows 1 through 3
The region B3: selects all data below and to the right of B3 (inclusive)
The region : selects all data in the sheet

Be sure to URL encode the region to avoid misinterpretation of the :.

value_style: The style of cell value to return. For example, if a cell’s value is =1+1 you can use:

raw to get the raw value =1+1
calculated to get the calculated value 2

Calculated values will be returned by default.

Enumerated Values#

Parameter	Value
value_style	`raw`
value_style	`calculated`

Code Samples#

curl

curl -X GET https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/data/{region} \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/data/{region} \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/data/{region}" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/data/{region}', headers = headers)

print(r.json())

Returns#