v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Messages

List messages you have sent.

Lists the messages your operator has sent, newest first. Required scope: messages:read

get/api/v1/messages

Query parameters

recipientUserIdinteger nullable

Only return messages sent to this user.

Example:42

readState'read' | 'unread' | 'any' nullable

Filter by whether the recipient has read the message.

Example:unread

afterstring nullable

Cursor from a previous response's meta.after to retrieve the next page.

perPageinteger nullable

Maximum number of messages to return (1–100).

Example:50

Response

List of messages that match the criteria

Example response

{
  "data": [
    {
      "id": "1024",
      "recipientUserId": 42,
      "body": "Your charge at Main Street is complete.",
      "subject": "Charge complete",
      "channels": {
        "webInbox": true
      },
      "deliveryResults": {
        "webInbox": {
          "status": "delivered",
          "at": "2026-06-26T13:40:01Z"
        },
        "mobilePush": {
          "status": "delivered",
          "at": "2026-06-26T13:40:01Z"
        },
        "email": {
          "status": "delivered",
          "at": "2026-06-26T13:40:01Z"
        },
        "sms": {
          "status": "delivered",
          "at": "2026-06-26T13:40:01Z"
        }
      },
      "readAt": "2026-06-26T13:47:14.123Z",
      "createdAt": "2026-06-26T13:40:00Z"
    }
  ],
  "meta": {
    "itemCount": 10,
    "perPage": 50,
    "after": "1290",
    "before": "1200"
  }
}