A LENS Board is called an entity and typically represents a single unit within your organization. Entities are organized in a hierarchal structure that is most easily visualized on the Reports page within LENS. A hospital system is divided into regions and a region entity can be divided into facilities. Each facility entity can contain a number of unit, leadership, template, or virtual* entities.

*A virtual entity exists only in the context of the Leader Rounds feature. Read more about virtual units here.

Request

GET {LENS_URL}/api/v2/entities

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

Response

Field	Description	Required
`_id`	The entity's unique ID.	Yes
`name`	The entity's name.	Yes
`groupName`	The entity's unique group name. An abbreviated version of the entity's name that can be used as a filter in many of the other endpoints.	Yes
`type`	The entity type, options include `region`, `facility`, `leadership`, `template`, `virtual`, and `work-setting` (this is a traditional unit).	Yes
`facilityName`	The corresponding facility `groupName`.	No
`training`	Whether the entity is a Training board, `true` or `false`.	No
`activeInReports`	Whether the entity's data is included in LENS reporting, `true` or `false`.	No
`boardId`	The `_id` of the default tab on the Voice page.	No
`SHOW_DAILY_MANAGEMENT`	Whether the entity displays the Daily Management tab on the Improvement page, `true` or `false`.	No
`SHOW_LEADER_ROUNDS`	Whether the entity displays the Leader Rounds page, `true` or `false`.	No
`timezone`	The entity's timezone.	No

Example Request

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

Example Response

{
  "data": [
    {
      "_id": "65f1a2b3c4d5e6f789012345",
      "name": "West Emergency Department",
      "groupName": "west-er",
      "type": "work-setting",
      "facilityName": "west",
      "training": false,
      "activeInReports": true,
      "boardId": "abc5AXYb23tQbEp2J",
      "SHOW_DAILY_MANAGEMENT": true,
      "SHOW_LEADER_ROUNDS": false,
      "timezone": "America/Chicago"
    }
  ],
  "metadata": {
    "endpoint": "entities",
    "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.

Welcome to LENS

Associate a Unit with a LENS Board

API Endpoint: Entities (LENS Boards)