Skip to content
View as Markdown

GET Campaign Options​

GET
/reports/campaign-options

Minimal {id, title} list of archived (i.e. already sent) campaigns, newest updated first. Built to populate the campaign selector on the reports screens.

This is a plain limit, not a paginator: there is no page parameter and no total. Narrow the result with search, whose LIKE wildcards are escaped and matched literally.

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

search

Case-insensitive substring match on the campaign title.

Type
string
per_page

Maximum number of options to return.

Type
integer
Default
50

Responses​

Campaign options.

application/json
JSON
{
"options": [
{
"id": 0,
"title": "string"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI