v15

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-11104961.0 KB
workbooks

Query workbook data

Read cell data or apply temporary changes.

Send a JSON object with a read key to read values from cells and formulas. Optionally, use the apply key to update cells before reading.

post/v1/workbooks/{id}/query

Path parameters

idstring required

Request body

Example request

{
  "apply": [
    {
      "target": "A2",
      "value": 1234
    }
  ],
  "read": [
    "A1:A4"
  ]
}

Response

Successful Response

Example response

{
  "apply": [
    {
      "target": "Sheet1!A1:B2"
    }
  ],
  "goalSeek": {
    "targetCell": "Sheet1!A1:B2",
    "controlCell": "Sheet1!A1:B2"
  },
  "read": [
    {
      "source": "Sheet1!A1:B2"
    }
  ]
}