Skip to main content
GET
List campaign messages

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

campaign_uuid
string<uuid>
required

The unique identifier for the campaign.

Example:

"YOUR_CAMPAIGN_UUID"

Query Parameters

index
integer

Filter by exact message index (positive integer).

Required range: x >= 1
message_type
enum<string>

Filter by message type.

Available options:
connection_request,
follow_up

Response

Campaign messages retrieved

campaign_uuid
string<uuid>
campaign_name
string
campaign_status
enum<string>
Available options:
draft,
active,
inactive,
finished
campaign_type
enum<string>
Available options:
new_connections,
existing_connections
campaign_messages
object[]