GET residentapi/units/{unitId}/alertmessages

Return messages for a unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
unitId

The unit the alert messages belong to

 integer

Required

Body Parameters

None.

Response Information

Resource Description

AlertMessage
NameDescriptionTypeAdditional information
MessageId

MessageId. Unique Identifier for a message..

 integer

None.
UnitId

ConnectUnitId. Id of the unit that the message belongs to. See GET /residentapi/units/{unitID}

 integer

None.
Message

Message.

 string

None.
Url

Url. The url to navigate to when the message is clicked.

 string

None.
ReadOn

Date the message was read (null if not read)

 date

None.
CreatedOn

CreatedOn. Date the notification was created.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "messageId": 1,
  "unitId": 2,
  "message": "sample string 3",
  "url": "sample string 4",
  "readOn": "2025-12-24T09:15:23.9922517-05:00",
  "createdOn": "2025-12-24T09:15:23.9922517-05:00"
}