Get campaign emails - PlusVibe.ai

Fetch campaign emails sent to a specific lead within a workspace. Optional campaign_id parameter can filter emails for a specific campaign.

{ "page_trail": "", "data": [ { "organization_id": "6509f7691205283f2a79f98b", "workspace_id": "6509f7691205283f2a79f98c", "lead_id": "673fa7040561f861461832a2", "current_step": 3, "sent_on": "2024-12-17T21:04:41.582Z", "variation": "A", "message_id": "<44cfd246-4b87-cc15-289d-c36c3e9d823f@gopiplai.com>", "subject": "Your Campaign Introduction", "body": "Hi there, this is a sample campaign email body. Let us know if you're interested!", "is_text": 1, "id": "6761e769c149e4d9ca7732fe", "campaign_id": "673fa3520561f86146182478", "eaccount": "sender@example.com", "lead": "lead@example.com" } ] }

Request

Query Params

workspace_id

string

required

The unique ID of the workspace.

Default:

Example:

6509f7691205283f2a79f98c

lead

string

required

The email address of the lead to retrieve campaign emails for.

Default:

Example:

lead@example.com

campaign_id

string

optional

(Optional) The unique ID of the campaign to filter emails.

Default:

Example:

673fa3520561f86146182478

Header Params

x-api-key

string

required

Your PlusVibe.ai account's API Key

Default:

Example:

your-api-key

Responses

🟢200OK

application/json

A list of campaign emails sent to the lead.

Body

page_trail

string

optional

A marker for pagination.

data

array [object {14}]

required

List of campaign emails.

organization_id

string

optional

The ID of the organization.

workspace_id

string

optional

The ID of the workspace.

lead_id

string

optional

The ID of the lead.

current_step

integer

optional

The current step in the campaign sequence.

sent_on

string

optional

Timestamp when the email was sent.

variation

string

optional

Email variation identifier.

message_id

string

optional

The unique ID of the email message.

subject

string

optional

The subject of the email.

body

string

optional

The body content of the email.

is_text

integer

optional

Indicates whether the email is plain text.

string

optional

The unique ID of the email record.

campaign_id

string

optional

The unique ID of the campaign.

eaccount

string

optional

The email account used to send the email.

lead

string

optional

The lead's email address.

🟠400Bad Request

🔴500Server Error