v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Streams

Get messages

List sent (outgoing) messages for your account, newest first. Supports pagination and filtering by stream, status, recipient, and date range.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/streams/messages

Query parameters

typestring

Message direction to return.

statusstring

Filter by delivery status.

streamIdinteger

Filter by stream ID.

phonestring

Filter by recipient phone number.

startDatestring

Include messages from this date (YYYY-MM-DD).

endDatestring

Include messages up to this date (YYYY-MM-DD).

pageinteger

Page number (1-based).

itemsPerPageinteger

Items per page.

Response

A page of sent messages.

totalinteger

Total number of matching records.

Example response

{
  "items": [
    {
      "type": "outgoing",
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "external_key": "ext-88213",
      "sent_at": "2026-03-19 10:15:10",
      "delivered_at": "2026-03-19 10:15:12",
      "status": "delivered",
      "source_number": "CommPeak",
      "source_name": "CommPeak",
      "destination_number": "447700900123",
      "country_code": "44",
      "country_iso2": "GB",
      "country_name": "United Kingdom",
      "platform": "sms",
      "content": {
        "type": "text",
        "body": "Hi Lando, your CommPeak code is 4821."
      },
      "conversation": "e2a489db-bb8a-4f51-9692-726153599c57",
      "stream": "5",
      "campaign": "1234"
    }
  ],
  "total": 128
}