A Voice page list contains cards and is associated with one tab at a time. Lists can be moved around if desired, optionally be excluded from reporting, and archived directly or indirectly when their tab is archived. Read more about creating lists here.

Request

GET {LENS_URL}/api/v2/lists

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 archived lists in response data.	No

Response

Field	Description	Required
`_id`	The list's unique ID.	Yes
`title`	The list's name.	Yes
`boardId`	Associated board `_id` where the list currently lives.	Yes
`archived`	Indicates whether the list has been archived, including if the tab it lives on was archived.	No
`reported`	Whether the list's data is factored into LENS reporting.	No

Example Request

GET https://example.safeandreliable.care/api/v2/lists?groupNames=west-er&includeArchived=true

Example Response

{
  "data": [
    {
      "_id": "Yb23tQbEp2Jabc5AX",
      "title": "Identified",
      "boardId": "abc5AXYb23tQbEp2J",
      "archived": false,
      "reported": true,
    },
    {
      "_id": "Zb33tMbEp4Jabc1dgI",
      "title": "In Progress",
      "boardId": "abc5AXYb23tQbEp2J",
      "archived": false,
      "reported": true,
    },
    {
      "_id": "Gyy73tMbNb4cv2c9gX",
      "title": "Completed",
      "boardId": "abc5AXYb23tQbEp2J",
      "archived": false,
      "reported": true,
    },
    {
      "_id": "b4Kl53bccNb4cv8v2",
      "title": "Holiday Fun!",
      "boardId": "abc5AXYb23tQbEp2J",
      "archived": true,
      "reported": false,
    },
  ],
  "metadata": {
    "endpoint": "lists",
    "count": 4,
    "filters": {
      "groupNames": [
        "west-er"
      ],
      "includeArchived": true
    }
  }
}

Looking for more support?

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

Archive a List

API Endpoint: Lists