Skip to main content
POST
/
v1
/
workbooks
/
{id}
/
export
JavaScript
import Grid from '@grid-is/api';

const client = new Grid({
  apiKey: 'My API Key',
});

const response = await client.workbooks.export('id');

console.log(response);

const content = await response.blob();
console.log(content);
"<string>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json

Request body for exporting a workbook as an .xlsx file. Cells can be updated before reading the workbook, and a goal seek function can be used to calculate the required input value for a formula to achieve a specified target result.

​
apply
DataTransformation · object[] | null

Cells to update before exporting.

Example:
[{ "target": "A2", "value": 1234 }]
​
goalSeek
QueryRequestGoalSeek · object

Goal seek. Use this to calculate the required input value for a formula to achieve a specified target result. Useful when the desired outcome is known, but the corresponding input is not

Response

Workbook exported as an .xlsx file

The response is of type file.