Worksheet: UsedRange

The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell.


The following scopes are required to execute this API:

HTTP request

POST /workbook/worksheets(<id|name>)/UsedRange

Request headers

Name Description
Authorization Bearer

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
valuesOnly boolean Optional. Considers only cells with values as used cells (ignores formatting).


If successful, this method returns 200, OK response code and Range object in the response body.


Here is an example of how to call this API.


Here is an example of the request.

Content-type: application/json
Content-length: 24

  "valuesOnly": true

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 169

  "address": "address-value",
  "addressLocal": "addressLocal-value",
  "cellCount": 99,
  "columnCount": 99,
  "columnIndex": 99,
  "valueTypes": "valueTypes-value"