Skip to main content

Broker Messages

Fetch list of messages flashed by the broker for a specific tenant. Messages include subject, content, time, and type, and are paginated for easier access.

🛣️Path Parameter

ParameterTypeDescriptionExample/ENUM
tenantidstringUnique identifier for tenant"TENANT001"

🔍Query Parameters

ParameterTypeDescriptionExample/ENUM
pageNointegerPage number for paginated result1
pageSizeintegerNumber of records per page10

🔑Header Parameters

HeaderTypeDescriptionExample/ENUM
AuthorizationstringBearer token used to authenticate requestBearer {{access_token}}
Content-TypestringSpecifies media type of request bodyapplication/json
x-api-keystringAPI key assigned to access this endpoint{{x-api-key}}

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusbooleanStatus of API executiontrue
resultarray of objectList of broker messagesSee details below

📘Message Object Structure

FieldTypeDescriptionExample/ENUM
MsgSrNointegerUnique message serial number1
SendMsgTimestringTimestamp when message was sent"2025-06-08T10:30:00Z"
SubjectstringTitle or subject of message"test broker message"
MessagestringFull message body sent by broker"broker message",
MsgTypeintegerType or category of message1
get/nontransactional/{tenantid}/v1/brokerMessages