Skip to main content

API Endpoint: Huddles

Retrieve the huddles scheduled on any of your LENS boards.

Written by Tristram Jones

A huddle is a scheduled huddle shown on the Today page of a LENS unit. Huddles can be configured from the Admin page as one-time* or recurring events and may include notes, duration settings, and selected recurrence days.

*One-time huddles will have recurring set to false and deleted is often null, though you often won't see these within LENS if they were scheduled in the past.

Request

GET {LENS_URL}/api/v2/huddles

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 huddles in response data.

No

Response

Field

Description

Required

_id

The huddle’s unique ID.

Yes

entity

Associated entity groupName where the huddle exists.

Yes

date

Scheduled date for the huddle or the date the recurrence was scheduled.

No

time

Scheduled start time for the huddle.

Yes

note

The name of the huddle.

No

optional

Indicates whether attendance is optional.

No

recurring

Indicates whether the huddle is recurring or a one-time occurence.

No

monday

Indicates whether the huddle recurs on Mondays.

No

tuesday

Indicates whether the huddle recurs on Tuesdays.

No

wednesday

Indicates whether the huddle recurs on Wednesdays.

No

thursday

Indicates whether the huddle recurs on Thursdays.

No

friday

Indicates whether the huddle recurs on Fridays.

No

saturday

Indicates whether the huddle recurs on Saturdays.

No

sunday

Indicates whether the huddle recurs on Sundays.

No

duration

Duration of the huddle in minutes.

No

deleted

Indicates whether the huddle has been deleted.

No

Example Request

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

Example Response

{
"data": [
{
"_id": "HxmaHybxLXcuXxmb2",
"entity": "west-icu",
"date": "2026-05-21T15:58:50.319Z",
"time": "16:00",
"note": "Morning Safety Huddle",
"optional": false,
"recurring": true,
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": false,
"friday": true,
"saturday": false,
"sunday": false,
"duration": 15,
"deleted": false
},
{
"_id": "cLz3aJimbsJk289xb",
"entity": "west-er",
"date": "2026-01-23T21:00:23.000Z",
"time": "15:00",
"note": "Leadership Briefing",
"optional": true,
"recurring": false,
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": false,
"saturday": false,
"sunday": false,
"duration": 20,
"deleted": true
},
],
"metadata": {
"endpoint": "huddles",
"count": 2,
"filters": {
"groupNames": [
"west-er",
"west-icu"
],
"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.

Did this answer your question?