---
title: "Retrieves text that labels cells and ranges in a workbook"
method: GET
path: "/v1/workbooks/{id}/labels"
tags: ["workbooks"]
---

# Retrieves text that labels cells and ranges in a workbook

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

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

## Path parameters

- `id` string, required

## Response `200`

Successful Response

- WorkbookLabelsResponse
  - `created` string, date-time, required — The date/time the labels 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
  - `labels` CellLabel[], required — The labels associated with the workbook
    - `at` string, required — The cell address/reference which the label applies to
    - `text` string, required — The label string
    - `for` string, required — The cell address/reference which the label applies to
    - `type` string, nullable — The type of the label, almost always text, not to be confused with cell type

## 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)