Skip to main content
GET
List Generated Messages
CLI:

Overview

Fetches generated campaign messages for one campaign. By default the endpoint returns draft messages; pass status=all, status=pending, or status=sent when reviewing another part of the message lifecycle. Pass prospect_id to focus on one lead. In that mode, inbound conversation replies are merged into the response so the UI can show the lead’s full thread context.

AI agent notes

Use this before editing generated copy or showing a human the messages that will be sent. This endpoint does not send or regenerate messages. Only call Edit generated email for draft messages the human wants to change.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Campaign UUID

Query Parameters

status
enum<string>
default:draft

Message status filter. Defaults to draft; all disables the status filter.

Available options:
draft,
pending,
sent,
all
prospect_id
string

Optional lead filter to fetch messages for one lead.

prospect_limit
integer

Optionally limit messages to the first N campaign leads.

Required range: 0 < x <= 100
prospect_offset
integer
default:0

Offset into the stable campaign lead order when prospect_limit is provided.

Required range: 0 <= x <= 9007199254740991

Response

Generated messages fetched successfully.

messages
object[]
required