fcrm list campaigns
fcrm_list_campaignsRetrieve a paginated list of email campaigns, with filters for status, labels, and title search, plus sorting and optional statistics.
Instructions
Retrieve a paginated list of email campaigns. Supports filtering by status, search term, labels, and sorting. Optionally includes campaign statistics.
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 |
|---|---|---|---|
| page | No | Page number. | |
| with | No | Include related data. Use `stats` to include campaign statistics and labels. | |
| labels | No | Filter by label IDs. | |
| account | No | Exact configured private account profile label; not a tenant or provider account ID. | |
| sort_by | No | Column to sort by. | created_at |
| per_page | No | Number of results per page. | |
| searchBy | No | Search campaigns by title. | |
| statuses | No | Filter by campaign statuses. | |
| sort_type | No | Sort direction. | DESC |