FluentCRM Developers

Appearance

View as Markdown

GET Report Emails​

GET
/reports/emails

Retrieve a paginated list of campaign emails with their associated subscriber and campaign data. Optionally filter by email status. When requesting page 1, the response also includes a breakdown of email counts grouped by status.

Required capability: fcrm_read_emails

Enforced by ReportPolicy::getEmails().

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​

Query Parameters

status

Filter emails by status (e.g., sent, pending, failed, bounced).

Type
string
page

Page number for pagination. When 1, the response includes status counts.

Type
integer
Default
1
per_page

Number of emails per page.

Type
integer
Default
15
search

Search across the recipient contact and the campaign.

Type
string
types[]

Filter by email type. Values are expanded server-side, so a broad type also matches its narrower variants.

Type
array

Responses​

Report emails retrieved successfully.

application/json
JSON
{
"emails": {
"current_page": 0,
"data": [
{
"id": 0,
"campaign_id": 0,
"subscriber_id": 0,
"status": "string",
"email_subject": "string",
"email_address": "string",
"is_open": 0,
"click_counter": 0,
"scheduled_at": "string",
"created_at": "string",
"updated_at": "string",
"subscriber": {
},
"campaign": {
}
}
],
"last_page": 0,
"per_page": 0,
"total": 0
},
"statuses": {
"additionalProperties": 0
},
"types": [
{
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI