fcrm get campaign
fcrm_get_campaignFetch a FluentCRM campaign by ID to inspect details, paginated emails, templates, or subjects; use it to review campaign data before managing or reporting.
Instructions
Retrieve a single campaign by ID. Optionally include related data (template, subjects) via the with parameter. When viewCampaign is set, returns the campaign with its paginated emails. Also returns available email templates and the server's current time.
Required capability: fcrm_read_emails or fcrm_manage_emails : which one applies depends on the action being performed.
Enforced by CampaignPolicy::verifyRequest(), the policy default for this route group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The campaign ID. | |
| with | No | Include related data (e.g., `template`, `subjects`). | |
| account | No | Exact configured private account profile label; not a tenant or provider account ID. | |
| viewCampaign | No | If set, returns the campaign with paginated emails instead of the standard response. |