List messages

Designing

GET

/messages

List and filter direct sends. Paging follows the house convention ({offset, limit, totalItems, totalPages, links}).

Filtering by type separates consent-exempt sends from ordinary ones, which is what makes this endpoint an audit surface as well as a debugging one.

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Matching messages.

Bodyapplication/json

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location '/messages?channel=undefined&type=undefined&basis=undefined&status=undefined&tag=undefined&contactId=undefined&clientContactId=undefined&from=undefined&to=undefined&limit=undefined&offset=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "messages": [
        {
            "messageId": "string",
            "channel": "string",
            "type": "string",
            "basis": "string",
            "status": "scheduled",
            "contactId": "string",
            "to": "string",
            "tags": [
                "string"
            ],
            "createdAt": "string",
            "sentAt": "string"
        }
    ],
    "paging": {
        "offset": 0,
        "limit": 0,
        "totalItems": 0,
        "totalPages": 0,
        "links": [
            {
                "href": "string",
                "rel": "next"
            }
        ]
    }
}

Modified at 2026-09-07 17:04:30

Validate SMS (dry run)

Get message