Skip to content
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 Experiment Campaigns​

GET
/setting/experiments/campaigns

Retrieve campaigns, newest first (ID descending), capped at 200 per request. Only id, title, email_subject and status are returned. Used in the experimental settings UI to allow selecting campaigns for experimental features.

Required capability: fcrm_manage_settings

Enforced by SettingsPolicy::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

searchBy

Case-insensitive substring match on the campaign title. Use it to reach campaigns beyond the 200 newest.

Type
string
limit

Maximum campaigns to return. Can only narrow the page: missing, non-positive or values above 200 fall back to 200.

Type
integer
Maximum
200
Default
200
include_ids

Campaign IDs appended to the result even when they fall outside the limit or the search, so already-saved selections resolve to a title. Capped at 200 IDs.

Type
array
Max Items
200

Responses​

List of campaigns (bounded, newest first).

application/json
JSON
{
"campaigns": [
{
"id": 0,
"title": "string",
"status": "string",
"email_subject": "string"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI