FluentCRM Developers

Appearance

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 Get Sequence​

GET
/sequences/{id}

Retrieve a single email sequence by ID. Optionally include the sequence emails and their individual statistics. Requires FluentCampaign Pro.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

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

id*

The sequence ID.

Type
integer
Required

Query Parameters

with[]

Include additional data. Use sequence_emails to include the sequence's emails. Use email_stats (requires sequence_emails) to include per-email statistics.

Type
array

Responses​

Sequence details.

application/json
JSON
{
"sequence": {
"id": 0,
"title": "string",
"slug": "string",
"status": "string",
"type": "string",
"design_template": "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",
"stats": {
"emails": 0,
"subscribers": 0,
"revenue": {
"amount": "string",
"currency": "string"
}
}
},
"sequence_emails": [
{
"id": 0,
"parent_id": 0,
"title": "string",
"slug": "string",
"type": "string",
"status": "string",
"design_template": "string",
"template_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"delay": 0,
"settings": {
"action_triggers": [
"string"
],
"timings": {
"delay_unit": "string",
"delay": "string",
"is_anytime": "string",
"sending_time": "string",
"selected_days_only": "string",
"allowed_days": [
"string"
]
},
"template_config": {
},
"mailer_settings": {
"from_name": "string",
"from_email": "string",
"reply_to_name": "string",
"reply_to_email": "string",
"is_custom": "string"
}
},
"utm_status": 0,
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string",
"utm_term": "string",
"utm_content": "string",
"created_by": 0,
"created_at": "string",
"updated_at": "string"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI