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

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

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

console.log(response.workbook_id);
{
  "created": "2023-11-07T05:31:56Z",
  "workbook_id": "<string>",
  "workbook_version": 123,
  "labels": [
    {
      "at": "<string>",
      "text": "<string>",
      "for": "<string>",
      "type": "<string>"
    }
  ]
}
Labels are textual identifiers that convey the semantic meaning of cells and ranges within a workbook. They are extracted from the structure, layout, and content in a workbook’s sheets.
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 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 · object[]
required

The labels associated with the workbook