FluentCRM Developers

Appearance

View as Markdown

GET Get Recurring Campaign Emails​

GET
/recurring-campaigns/{campaign_id}/emails

Retrieve a paginated list of child email campaigns (recurring mails) for a recurring campaign. Non-draft emails are returned paginated. On the first page, draft emails are also included separately. 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​

Path Parameters

campaign_id*

The recurring campaign ID.

Type
integer
Required

Query Parameters

per_page

Number of results per page.

Type
integer
Default
15
page

Page number for pagination. When page is 1, draft emails are included in a separate drafts field.

Type
integer
Default
1

Responses​

List of recurring campaign emails.

application/json
JSON
{
"emails": {
"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,
"parent_id": 0,
"title": "string",
"slug": "string",
"type": "string",
"status": "string",
"template_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"recipients_count": 0,
"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"
}
},
"created_by": 0,
"created_at": "string",
"updated_at": "string"
}
]
},
"drafts": [
{
"id": 0,
"parent_id": 0,
"title": "string",
"slug": "string",
"type": "string",
"status": "string",
"template_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"recipients_count": 0,
"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"
}
},
"created_by": 0,
"created_at": "string",
"updated_at": "string"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI