API Reference

Description

GET /spreadsheets/{SpreadsheetId}/sheets

🚧

Required OAuth Scopes:

data_tables|r

Parameters

ParameterInTypeRequiredDescription
SpreadsheetIdpathstringtrueA unique identifier for a spreadsheet
revisionqueryinteger(int32)falseThe spreadsheet revision from which to select data. If no revision is provided, the latest revision will be selected.

Code Samples

curl -X GET https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{SpreadsheetId}/sheets  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{SpreadsheetId}/sheets  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{SpreadsheetId}/sheets" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  '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.

Example Responses


{
  "data": [
    {
      "child_ids": [
        "h65a604b74564afa86b5ba96755845652"
      ],
      "id": "k78a604b74564afa76b5ba96755123456",
      "index": "integer",
      "name": "Data Sheet",
      "parent_id": "d10a604b74564afa86b5ba96755845652"
    }
  ],
  "message": "Operation successful",
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c",
  "revision": "integer"
}