API ReferenceConversations

List Conversations

Retrieves conversations by page with optional filtering based off provided parameters.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
pageIndexintegerRequired>=0

Zero-based index for pagination.

brandIdstringOptional

The unique identifier of the brand to filter conversations. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

campaignIdstringOptional
The unique identifier of the campaign to filter conversations. This identifier is a string that begins with the prefix: - TOLL_FREE: `tf_` (e.g., `tf_1234567890`) - 10DLC: `dlc_` (e.g., `dlc_1234567890`) - RCS: `rcs_` (e.g., `rcs_1234567890`)
campaignTypeenumOptional
The type of campaign: - TOLL_FREE: Toll-free number campaigns - 10DLC: 10-digit long code campaigns for A2P messaging - RCS: Rich Communication Services campaigns
Allowed values:
pageSizeintegerOptional>=1Defaults to 10
Number of conversations to return per page.
receiverstringOptional
Receiver's phone number in E.164 format.
senderstringOptional
The sender identifier. Can be either: - A phone number in E.164 format - An RCS agent ID prefixed with 'agent_'

Response

Returns conversations that meets your filters.
countinteger
Total number of conversations matching the filter.
conversationslist of objects
hasMoreboolean
Indicates if more conversations are available beyond the current page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error