Skip to main content

API Endpoint: Card Comments

Retrieves card comments from Voice cards.

Written by Tristram Jones

A card comment represents a comment made to a Voice card and includes both standard and SMS comments, depending on how the comment was added.

Request

GET {LENS_URL}/api/v2/cardComments

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 comments associated with archived Voice cards in response data.

No

days

Filter response data to comments on Voice cards created 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 card comment’s unique ID.

Yes

cardId

Associated card _id where the comment lives.

Yes

createdAt

Date and time the comment was created.

Yes

text

The comment’s content.

Yes

commentType

Type of comment. Values include sms-comment and card-comment.

Yes

Example Request

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

Example Response

{
"data": [
{
"_id": "RvaSm7jjgNqIlk88po",
"cardId": "z9X8yyPJmEjLbCK5k",
"createdAt": "2026-05-01T15:04:22.000Z",
"text": "Followed up with the charge nurse for more details.",
"commentType": "sms-comment"
},
{
"_id": "oK2ZZ34M8QZojpC32R",
"cardId": "z9X8yyPJmEjLbCK5k",
"createdAt": "2026-05-02T10:18:45.000Z",
"text": "work order has been put in, moving this to in progress",
"commentType": "card-comment"
},
{
"_id": "Ag40vD4r69YzkhYpc9",
"cardId": "sHnfu2FJjWJErprYB",
"createdAt": "2026-05-17T10:38:08.113Z",
"text": "Congratulations!",
"commentType": "card-comment"
}
],
"metadata": {
"endpoint": "cardComments",
"count": 3,
"filters": {
"groupNames": [
"west-er"
]
}
}
}


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?