Retrieve a list of sheets

Description

Returns a list of sheets.

GET /spreadsheets/{spreadsheetId}/sheets

🚧
Required OAuth Scopes:
file:read

Parameters

Parameter	In	Type	Required	Description
spreadsheetId	path	string	true	The unique identifier of the spreadsheet

Code Samples

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

http GET https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"

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

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Sheet objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn't appear. If the request returns no results at all, data contains an empty array.

Example Responses


{
  "data": [
    {
      "id": "242a56d3cc0742c8abad0820bd318b23",
      "name": "Q1",
      "parent": null,
      "index": 0,
      "children": [],
      "dataset": null
    },
    {
      "id": "132b55d1cd0543c1aaae0924bc328a24",
      "name": "Q2",
      "parent": null,
      "index": 1,
      "children": [],
      "dataset": null
    }
  ],
  "@nextLink": "{opaqueUrl}"
}