Skip to main content
GET
Get Contact Messages

Campaign-originated messages

A message sent by a campaign carries the step it came from: stepId, the stable identifier of that step, alongside the sequenceId, the 0-based sequenceStep position, and totalSequenceStep. Prefer stepId when you store a reference — sequenceStep shifts when a sequence’s steps are reordered.
stepId is present on every message recorded from now on; older messages gain it progressively as historical records are backfilled. sequenceStep is unchanged and keeps being returned.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

contactId
string
required

The unique identifier of the contact

Query Parameters

userId
string

ID of the user viewing the conversation

limit
integer

The maximum number of records to return

skip
integer

Number of items to skip. Default: 0

markAsRead
boolean

When true, marks the conversation as read. Default: false

Response

Success

data
object[]
pagination
object