Retrieve a single sheet

Description

Retrieves a sheet given its ID.

GET /spreadsheets/{spreadsheetId}/sheets/{sheetId}

Required OAuth Scopes

file:read

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-01-01)
spreadsheetId	path	string	true	The unique identifier of the spreadsheet
sheetId	path	string	true	The unique identifier of the sheet
$revision	query	string	false	Returns resources at a specific revision

Code Samples

curl

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

httpie

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

wget

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

python

import requests

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

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

print(r.json())

Returns

200 - OK

Returns a Sheet object containing details about the requested Sheet.

400 - Bad Request

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses

200 Response

{
  "children": [],
  "customFields": {
    "com.workiva.gsr.legal_entity": "Workiva"
  },
  "dataset": null,
  "id": "242a56d3cc0742c8abad0820bd318b23",
  "index": 0,
  "lock": null,
  "modified": {
    "dateTime": "2020-03-21T15:03:27Z"
  },
  "name": "Q1",
  "parent": null,
  "table": {
    "revision": "2B3C4D5E",
    "table": "8610c7b132e944cb9e5c11daf08b1b1c"
  }
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}