reach_listCampaignsV1
Retrieve a paginated list of email campaigns with engagement rates, filtering by status (draft, scheduled, sending, sent) and type (regular, automation, double opt-in).
Instructions
Get a paginated list of the campaigns in a profile.
Each campaign carries its headline engagement rates. Filter by status to find drafts,
scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the
status publish. By default only regular campaigns are returned - pass type to get the
emails sent by automations or the double opt-in confirmations instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| type | No | Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations. | |
| status | No | Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived. | |
| per_page | No | Number of items per page | |
| profileUuid | Yes | Profile uuid parameter | |
| sort_direction | No | Order campaigns by creation date. Newest first unless set to `asc`. |