FluentCRM Developers

Appearance

View as Markdown

GET List Recurring Campaigns​

GET
/recurring-campaigns

Retrieve a paginated list of recurring email campaigns. Supports filtering by search term and labels, and sorting by column and direction. Each campaign includes an emails_count of child mail campaigns and formatted labels. If the campaign is active with manual sending, a has_draft flag indicates whether a draft email exists. Requires FluentCampaign Pro.

Required capability: fcrm_read_emails

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

Requires: FluentCampaign Pro. Without it the route does not exist.

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

Search recurring campaigns by title.

Type
string
order

Sort direction.

Type
string
Valid values
"asc""desc"
Default
"desc"
orderBy

Column to sort by.

Type
string
Default
"id"
labels[]

Filter by label IDs.

Type
array
per_page

Number of results per page.

Type
integer
Default
15
page

Page number for pagination.

Type
integer
Default
1
statuses[]

Filter recurring campaigns by status.

Type
array

Responses​

Paginated list of recurring campaigns.

application/json
JSON
{
"campaigns": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"next_page_url": "string",
"prev_page_url": "string",
"from": 0,
"to": 0,
"data": [
{
"id": 0,
"title": "string",
"slug": "string",
"status": "string",
"type": "string",
"template_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"recipients_count": 0,
"utm_status": 0,
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string",
"utm_term": "string",
"utm_content": "string",
"design_template": "string",
"scheduled_at": "string",
"settings": {
"mailer_settings": {
"from_name": "string",
"from_email": "string",
"reply_to_name": "string",
"reply_to_email": "string",
"is_custom": "string"
},
"scheduling_settings": {
"type": "string",
"day": "string",
"time": "string",
"send_automatically": "string"
},
"sending_conditions": [
{
}
],
"subscribers_settings": {
"subscribers": [
{
}
],
"excludedSubscribers": [
{
}
],
"sending_filter": "string",
"dynamic_segment": {
},
"advanced_filters": [
[
]
]
},
"template_config": {
}
},
"created_by": 0,
"created_at": "string",
"updated_at": "string"
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI