API ReferenceConversations

Get Conversation

Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
Get by IDobjectRequired
Retrieve conversation information by ID.
OR
Get by ParticipantsobjectRequired
Retrieve conversation information by sender and recipient.

Response

Returns the full conversation details, or null if not found.
brandIdstring or null

The unique identifier of the brand associated with this conversation. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

campaignobject or null
Campaign information if this conversation is part of a marketing campaign. This is an object that contains the campaign ID and type.
contactobject
Contact information for the recipient in a conversation.
createdAtstring
ISO 8601 timestamp when the conversation was created.
idstring

Unique identifier for the conversation. This identifier is a string that always begins with the prefix conv_, for example: conv_1234567890.

notesstring

Free-form notes or comments about the conversation.

senderobject or null
The sender of messages in this conversation. Can be: - A phone number with its capabilities and metadata - An RCS agent with ID and name - `null` if no sender is associated
updatedAtstring
ISO 8601 timestamp when the conversation was last updated.

Errors