v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Streams

Get incoming messages

List incoming (inbound) messages for your account, newest first. Supports pagination and filtering by stream, sender, destination, and date range.

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

get/streams/incoming_messages

Query parameters

streamIdinteger

Filter by stream ID.

phonestring

Filter by sender phone number.

destinationstring

Filter by destination number / sender ID.

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 incoming messages.

totalinteger

Total number of matching records.

Example response

{
  "items": [
    {
      "message_uuid": "c4fff8ff-086a-4498-885f-760af8714eeb",
      "received_at": "2026-03-19 10:20:04",
      "from": "447700900123",
      "to": "CommPeak",
      "contact_name": "Lando Norris",
      "country_code": "44",
      "country_iso2": "GB",
      "country_name": "United Kingdom",
      "body": "STOP",
      "message_length": 4,
      "conversation": "e2a489db-bb8a-4f51-9692-726153599c57",
      "stream": "5"
    }
  ],
  "total": 128
}