Streams

Get messages

Changed on Nov 3, 2026

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

Pagination. page (1-based, default 1) and itemsPerPage (default 30). The response is { "items": [ ... ], "total": N }.

Dates. startDate and endDate accept YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (UTC). A bare date means midnight at the start of that day, so to include all of March 31 send endDate=2026-04-01.

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

get/streams/messages

Request

Base URL
https://api.commpeak.com/textpeak
URL
https://api.commpeak.com/textpeak/streams/messages
Auth
API key in header Authorization

Query parameters

pageinteger nullable

Page number (1-based).

itemsPerPageinteger nullable

Items per page.

streamIdinteger nullable

Only messages sent on this stream ID.

Delivery status.

phonestring nullable

Recipient phone number contains this text.

startDatestring nullable

Sent at or after this time (UTC).

endDatestring nullable

Sent at or before this time (UTC).

Response

Successful Response

totalinteger nullable

Total number of matching messages.

Example response

{
  "items": [
    {
      "campaign": [],
      "content": {
        "body": "Hi John, your CommPeak code is 4821.",
        "type": "text"
      },
      "conversation": {
        "uuid": "e2a489db-bb8a-4f51-9692-726153599c57"
      },
      "cost": 0.0075,
      "country_code": 230,
      "country_iso2": "US",
      "country_name": "USA",
      "delivered_at": "2026-03-19 10:15:12",
      "destination_number": "12125551234",
      "external_key": "1001",
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "platform": "api",
      "sent_at": "2026-03-19 10:15:10",
      "sms": {
        "length": 36,
        "mcc": "310",
        "mnc": "004",
        "network": "Verizon",
        "parts": 1,
        "utf8": false
      },
      "source_name": "CommPeak",
      "source_number": "CommPeak",
      "status": "delivered",
      "stream": {
        "name": "Marketing US",
        "type": "MARKETING",
        "uuid": "9f1c2d3e4b5a6789c0d1e2f3a4b5c6d7"
      },
      "type": "SMS",
      "whatsapp": []
    }
  ],
  "total": 128
}

Changes

Nov 3, 20265012671cf95d Revision changes
- breaking
  for the query request parameter itemsPerPage, default value 30 was added
- breaking
  for the query request parameter page, default value 1 was added
- breaking
  response property items/items/cost list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/country_code list-of-types was widened by adding types integer and null to media type application/json of response 200
- breaking
  response property items/items/country_iso2 list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/country_name list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/delivered_at list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/destination_number list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/external_key list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/message_uuid list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/platform list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/sent_at list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/source_name list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/source_number list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/items/type list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property total list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from object to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- warning
  deleted the query request parameter type
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  added the new SMS enum value to the // response property for the response status
- warning
  added the new WHATSAPP enum value to the // response property for the response status
- info
  api operation id getMessages removed and replaced with list_messages
- info
  the endpoint scheme security APIKeyHeader was added to the API
- info
  query request parameter endDate list-of-types was widened by adding types null
- info
  query request parameter itemsPerPage list-of-types was widened by adding types null
- info
  query request parameter page list-of-types was widened by adding types null
- info
  query request parameter phone list-of-types was widened by adding types null
- info
  query request parameter startDate list-of-types was widened by adding types null
- info
  query request parameter streamId list-of-types was widened by adding types null
- info
  for the query request parameter endDate, the type was generalized from string to no type
- info
  for the query request parameter itemsPerPage, the type was generalized from integer to no type
- info
  for the query request parameter page, the type was generalized from integer to no type
- info
  for the query request parameter phone, the type was generalized from string to no type
- info
  for the query request parameter startDate, the type was generalized from string to no type
- info
  for the query request parameter status, the type was generalized from string to no type
- info
  for the query request parameter streamId, the type was generalized from integer to no type
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added subschema #2 subschema #3 to the // response property anyOf list for the response status
- info
  added subschema #2 to the // response property anyOf list for the response status
- info
  added subschema #2 to the // response property anyOf list for the response status
- info
  added subschema #2 to the // response property anyOf list for the response status
- info
  added subschema #2 to the // response property anyOf list for the response status
- info
  the response property became required for the status
- info
  the response's property default value 0 was added for the status

Operation history