---
title: "Retrieves the cells whose values drive the calculations in a workbook, such as its assumptions or inputs"
method: GET
path: "/v1/workbooks/{id}/parameters"
tags: ["workbooks"]
---

# Retrieves the cells whose values drive the calculations in a workbook, such as its assumptions or inputs

`GET /v1/workbooks/{id}/parameters`

Retrieve labels automatically detected for cells and ranges in the workbook.

## Path parameters

- `id` string, required

## Response `200`

Successful Response

- WorkbookParametersResponse
  - `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[], required — The parameters associated with the workbook
    - `ref` string, required — The cell address/reference containing the parameter
    - `type` 'blank' | 'date' | 'number' | 'string' | 'boolean' | 'error', required
    - `value` union — The value in the parameter cell, type is determined by the type field
      - string
      - integer
      - number
      - boolean
    - `labels` BaseCellLabel[], required — The labels associated with the parameter
      - `at` string, required — The cell address/reference which the label applies to
      - `text` string, required — The label string

## Other responses

- `400` — Error returned when you make a bad request
- `403` — Error returned when you don't have permission to query a workbook
- `429` — Error returned when you exceed your API rate limit

---

[API](https://skmtc.net/grid-is/apis/grid-api.md) · [All operations](https://skmtc.net/grid-is/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/grid-is/grid-api/versions/2f55490ab23d/schema)