POST
/
v1
/
workbooks
/
{id}
/
export
import Grid from '@grid-is/api';

const client = new Grid({
  apiKey: process.env['GRID_API_TOKEN'], // This is the default and can be omitted
});

async function main() {
  const response = await client.workbooks.export('id');

  console.log(response);

  const content = await response.blob();
  console.log(content);
}

main();
This response does not have an example.

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.

Response

200
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Workbook exported as an .xlsx file

The response is of type file.