API ReferenceMessages

List Messages

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
Allowed values:
statusenumOptional
typeenumOptional
Allowed values:
methodenumOptional
Filter by the method used to send the message.
Allowed values:
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