List campaigns
plunk_list_campaignsList campaigns with their status—draft, scheduled, sending, or sent—to find campaign IDs, see what exists, or check what is scheduled. Archived campaigns hidden unless archived is true.
Instructions
Purpose: List campaigns with their status — draft, scheduled, sending or sent.
Not for: Performance figures. This tells you a campaign exists and what state it is in; plunk_get_campaign_stats tells you how it did.
Returns: A page of campaigns with ids, names, subjects and statuses.
Use when: You need a campaign id, or the user asks what campaigns exist or what is scheduled.
Note: Archived campaigns are hidden by default; pass archived true to see them. Search, sort and the archived filter require Plunk v0.15+.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dir | No | ||
| page | No | ||
| sort | No | ||
| search | No | Filter by name or subject. | |
| status | No | ||
| archived | No | true lists archived campaigns instead of the default list. Plunk v0.15+. | |
| pageSize | No |