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

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

const response = await client.beta.getWorkbookParameters('id');

console.log(response.workbook_id);
{
  "created": "2023-11-07T05:31:56Z",
  "workbook_id": "<string>",
  "workbook_version": 123,
  "parameters": [
    {
      "ref": "<string>",
      "type": "blank",
      "labels": [
        {
          "at": "<string>",
          "text": "<string>"
        }
      ],
      "value": "<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

Successful Response

​
created
string<date-time>
required

The date/time the parameters were detected and stored

​
workbook_id
string
required

The id of the workbook the labels belong to

​
workbook_version
integer
required

The version of the workbook the labels belong to

​
parameters
ModelParameter · object[]
required

The parameters associated with the workbook