Pinnacle
API ReferenceMessages

List Messages

Serverhttps://api.pinnacle.sh/
POST
/messages/list

Request body

Edit JSON, then apply it to your request.

JSON

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

Authorization

Pinnacle API key
PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageIndexintegerOptional
Range
0 <= value
Default
0
pageSizeintegerOptional
Range
1 <= value <= 100
Default
20
directionstringOptional
Allowed values
"INBOUND""OUTBOUND"
statusstringOptional
Allowed values
"PENDING""SENT""SEND_FAILED""DELIVERED""DELIVERY_FAILED""RECEIVED""READ""QUEUED""FALLBACK_SENT"
typestringOptional
Allowed values
"SMS""MMS""RCS"
methodstringOptional

Filter by the method used to send the message.

Allowed values
"API""SDK""OTHER"
fromstringOptional

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

Example
"agent_pinnacle"
tostringOptional

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

Example
"+14155550142"
contentstringOptional

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

Example
"Hello from Pinnacle!"
dateFromstringOptional

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

Format
date-time
Example
"2026-10-15T17:30:00Z"
dateTostringOptional

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

Format
date-time
Example
"2026-10-15T17:30:00Z"

Response Body

application/json

application/json

application/json

application/json

List Scheduled MessagesPOST

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

React to a MessagePOST

Add or remove an emoji reaction to a previously sent message.

Pinnacle referenceAsk Pinnacle

Get a sourced answer from the published documentation.

ViewingPinnacle documentation

Conversations are saved for analysis.

Try asking