Skip to main content

API Endpoint: Huddle Data

Fetch huddle data representing each time a huddle occurred within one of your LENS units.

Written by Tristram Jones

Huddle data represents a specific occurrence of a huddle in LENS. Each time a LENS unit records a huddle, a huddle data item is created that includes information like the huddle it is associated with and the time and duration of the huddle. Huddle data is considered archived if it was deleted manually or its associated huddle was deleted.

Request

GET {LENS_URL}/api/v2/huddleData

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 huddle data, including data linked to archived huddles, in response data.

No

days

Filter response data to huddle data recorded within the specified number of days prior to the current date. Accepted values range from 1 to 365, default is 7.

No

Response

Field

Description

Required

_id

The huddle data's unique ID.

Yes

huddleId

Associated huddle _id.

Yes

startDate

Date and time the huddle session started.

No

endDate

Date and time the huddle session ended.

No

duration

Duration of the huddle session in seconds.

No

Example Request

GET https://example.safeandreliable.care/api/v2/huddleData?groupNames=west-icu

Example Response

{
"data": [
{
"_id": "KwmqJP24hZZBphmAk",
"huddleId": "HxmaHybxLXcuXxmb2",
"startDate": "2026-05-25T22:27:12.305Z",
"endDate": "2026-05-25T22:36:15.977Z",
"duration": 543
},
{
"_id": "7Wi5NCPmPPGz7qPnC",
"huddleId": "HxmaHybxLXcuXxmb2",
"startDate": "2026-05-27T22:31:56.055Z",
"endDate": "2026-05-27T22:42:30.098Z",
"duration": 634
},
],
"metadata": {
"endpoint": "huddleData",
"count": 2,
"filters": {
"groupNames": [
"west-icu"
]
}
}
}


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?