FluentCRM Developers

Appearance

View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

GET Get Campaign Emails​

GET
/campaigns/{id}/emails

Retrieve a paginated list of emails sent for a specific campaign. Supports filtering by engagement type (click, view, unopened, failed) and searching by subscriber details. Optionally includes the campaign data with tracking status.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

Enforced by CampaignPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The campaign ID.

Type
integer
Required

Query Parameters

filter_type

Filter emails by engagement type.

Type
string
Valid values
"click""view""unopened""failed"
search

Search by subscriber name or email.

Type
string
with_campaign

Set to include the campaign object (with tracking status) in the response.

Type
string
per_page

Number of results per page.

Type
integer
Default
15
page

Page number.

Type
integer
Default
1

Responses​

Campaign emails retrieved successfully.

application/json
JSON
{
"emails": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"data": [
{
"id": 0,
"campaign_id": 0,
"subscriber_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"status": "string",
"is_open": 0,
"click_counter": 0,
"scheduled_at": "string",
"created_at": "string",
"updated_at": "string",
"subscriber": {
"id": 0,
"email": "string",
"first_name": "string",
"last_name": "string",
"status": "string"
}
}
]
},
"failed_counts": 0,
"campaign": {
"id": 0,
"title": "string",
"open_tracking_status": "string",
"click_tracking_status": "string"
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI