Skip to main content

API Endpoint: Labels

Retrieve the available labels on each of your LENS boards.

Written by Tristram Jones

Labels can be applied to Voice cards in LENS. Labels help organize, categorize, and filter Voice cards across boards and workflows. Read more about using labels to manage your LENS data here.

Request

GET {LENS_URL}/api/v2/labels

Headers

Include your PAT in the Authorization header of your request.

Header

Description

token

Your Personal Access Token

Query Parameters

Parameter

Description

Required

groupNames

Comma-separated list of entity group names.

No

includeArchived

Include deleted labels in response data.

No

Response

Field

Description

Required

_id

The label’s unique ID.

Yes

name

The label’s name.

Yes

Example Request

GET https://example.safeandreliable.care/api/v2/labels?groupNames=west-er

Example Response

{
"data": [
{
"_id": "4623MfqqrHyGCsJ7D",
"name": "Patient Safety"
},
{
"_id": "xB3G4F9aHT5dM34Lq",
"name": "Infection Prevention"
},
{
"_id": "gT8TX4v4ioNKpRm7j",
"name": "Celebrations"
},
{
"_id": "5e7O22sM84ce043c0",
"name": "Equipment"
},
],
"metadata": {
"endpoint": "labels",
"count": 4,
"filters": {
"groupNames": [
"west-er"
]
}
}
}


Looking for more support?

We’re here to help — email us at LENSsupport@safeandreliablecare.com or click the Help button on your LENS board.

Did this answer your question?