A board represents a tab on the Voice page and is tied to a single entity. Boards help organize lists, workflows, and reporting for each LENS unit's Voice page. Most entities have a designated default board, which is the tab users see automatically when first opening the Voice page. Learn more about configuring default tabs here.
Request
GET {LENS_URL}/api/v2/boards
Headers
Include your PAT in the Authorization header of your request.
Header | Description |
| Your Personal Access Token |
Query Parameters
Parameter | Description | Required |
| Comma-separated list of entity group names. | No |
| Include archived tabs in response data. | No |
Response
Field | Description | Required |
| The board's unique ID. | Yes |
| The board's name. | Yes |
| Associated entity | Yes |
| Indicates whether the tab has been archived. | No |
Example Request
GET https://example.safeandreliable.care/api/v2/boards?groupNames=west-er
Example Response
{
"data": [
{
"_id": "abc5AXYb23tQbEp2J",
"title": "Kudos",
"groupName": "west-er",
"archived": false
}
],
"metadata": {
"endpoint": "boards",
"count": 1,
"filters": {
"groupNames": [
"west-er"
],
"includeArchived": false
}
}
}
Looking for more support?
We’re here to help — email us at LENSsupport@safeandreliablecare.com or click the Help button on your LENS board.