Skip to main content
GET
Participant messages

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

id
string
required

Initiative id.

Minimum string length: 1
participantId
string
required

Participant id, as returned when adding or listing.

Minimum string length: 1

Query Parameters

scope
enum<string>
default:initiative

initiative (default) = only what was said under this initiative. customer = this person's whole message history across every initiative, each message tagged with the one it belongs to.

Available options:
initiative,
customer

Response

Success

participantId
string
required
phoneNumber
string | null
required
channel
string
required
scope
enum<string>
required
Available options:
initiative,
customer
data
object[]
required
next_cursor
null
required