List Messages | Pinnacle

{
  "data": [
    {
      "id": "msg_abc123",
      "status": "DELIVERED",
      "direction": "OUTBOUND",
      "type": "SMS",
      "method": "API",
      "numSegments": 1,
      "cost": 0.0079,
      "from": "+12125551234",
      "to": "+14155556789",
      "content": {
        "text": "Your order has shipped!"
      },
      "error": null,
      "isTest": false,
      "blastId": null,
      "sentAt": "2025-01-15T10:30:01Z",
      "deliveredAt": "2025-01-15T10:30:03Z",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:03Z"
    }
  ],
  "hasMore": true,
  "count": 156
}

List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

pageIndexintegerOptional>=0Defaults to 0

pageSizeintegerOptional1-100Defaults to 20

directionenumOptional

statusenumOptional

typeenumOptional

methodenumOptional

Filter by the method used to send the message.

fromstringOptional

Filter by sender phone number (E.164 format) or agent id.

tostringOptional

Filter by recipient phone number (E.164 format).

contentstringOptional

Search message content (partial match, case-insensitive).

dateFromstringOptionalformat: "date-time"

Filter messages created on or after this date (ISO 8601 format).

dateTostringOptionalformat: "date-time"

Filter messages created on or before this date (ISO 8601 format).

Response

Returns paginated list of messages.

datalist of objects

hasMoreboolean

countinteger

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.messages.list({});
8	}
9	main();