Skip to content
View as Markdown

GET Campaigns List Report​

GET
/reports/campaigns-list

Paginated list of archived campaigns, most recently updated first, each with its stats block attached.

Rows are full campaign records — including email_body — so responses are large. When you only need identifiers for a picker, use GET /reports/campaign-options instead.

Required capability: fcrm_view_dashboard

Enforced by ReportPolicy::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​

Query Parameters

per_page

Campaigns per page.

Type
integer
Default
15
page

Page number.

Type
integer
Default
1

Responses​

Paginated campaigns with stats.

application/json
JSON
{
"campaigns": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"from": 0,
"to": 0,
"next_page_url": "string",
"prev_page_url": "string",
"data": [
{
"id": 0,
"title": "string",
"status": "string",
"email_subject": "string",
"email_body": "string",
"updated_at": "string",
"stats": {
"total": 0,
"sent": 0,
"opened": 0,
"clicked": 0
}
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI