ts.msg.inbox

List unread/recent messages for current resource.

List unread/recent messages for current resource.

Requires authentication

Description

Retrieves the inbox for the authenticated user’s resource. Returns messages delivered to the user, newest first.

Supports filtering by delivery status, message intent, entity context, and unread flag.

Parameters

NameTypeRequiredDefaultDescription
statusstringFilter by status: pending, delivered, read
intentstringFilter by intent: info, question, action, alert
unreadbooleanShow only unread messages (status != read)
entity_typestringFilter by context entity type
entity_idstringFilter by context entity ID
limitinteger50Max results (default: 50)
offsetinteger0Pagination offset

Response

Returns a paginated list of inbox messages.

{
  "limit": 50,
  "messages": [
    {
      "id": "msg_a1b2c3d4e5f6",
      "intent": "info",
      "status": "pending",
      "subject": "Update"
    }
  ],
  "offset": 0,
  "total": 1
}

Errors

CodeDescription
not_authenticatedNo active login for this session

Examples

Check inbox

Get unread messages.

Request:

{
  "unread": true
}

Response:

{
  "limit": 50,
  "messages": [
    {
      "id": "msg_a1b2c3d4e5f6",
      "intent": "action",
      "status": "pending"
    }
  ],
  "offset": 0,
  "total": 1
}