GET
/
v1
/
workbooks
/
{id}
/
parameters
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.beta.getWorkbookParameters('id');

  console.log(response.workbook_id);
}

main();
{
  "created": "2023-11-07T05:31:56Z",
  "workbook_id": "<string>",
  "workbook_version": 123,
  "parameters": [
    {
      "ref": "<string>",
      "type": "blank",
      "value": "<string>",
      "labels": [
        {
          "at": "<string>",
          "text": "<string>"
        }
      ]
    }
  ]
}

Spreadsheets often contain cells that are assumptions and input values for its calculations. We call these parameters. For example, in a financial model, parameters might include interest rates, tax rates, or other key inputs that affect the overall results of the model. Parameters are always simple values like numbers, and will never be formulas.

This endpoint is in beta and is subject to change.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200
application/json

Successful Response

The response is of type object.