Ctrl+K

Retrieve a list of range values

Retrieve a list of range values#

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 the paginated values for a specified range. When you retrieve values from a range, Ones scale is used regardless of the cell’s scale formatting.

GET /platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/values/{range}

Required OAuth Scopes

file:read

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

range

path

string

true

The range of values, in A1-style notation

$maxcellsperpage

query

integer

false

The maximum number of cells to retrieve. The default is 50000. The maximum allowed value is 50000.

$next

query

string

false

Pagination cursor for next set of results.

$valuestyle

query

string

false

Whether to retrieve raw or calculated cell values. For example, if a cell’s value is =1+1, raw retrieves the value =1+1, while calculated retrieves 2.

Enumerated Values#

Parameter

Value

$valuestyle

raw

$valuestyle

calculated

Code Samples#

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

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

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

import requests

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

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

print(r.json())

Returns#

200 - OK#

Returns a JSON object with data and @nextLink properties. data contains a single RangeValues object, 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.

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#

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "range": "A1:C3",
      "values": [
        [
          "First",
          "Second",
          "Third"
        ],
        [
          1,
          2,
          ""
        ],
        [
          3,
          4,
          5
        ]
      ]
    }
  ]
}

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

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

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

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

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

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

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

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