Return a list of all sheets in the outline and their properties#

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#

GET /spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets

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
revision	query	integer(int32)	false	The spreadsheet revision from which to select data. If no revision is provided, the latest revision will be selected.

Code Samples#

curl

curl -X GET https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets \
    -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 \
    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" \
    --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', headers = headers)

print(r.json())

Returns#

200 - OK#

Returns a JSON object with data and revision properties. data contains a list of requested Sheet objects.