Read campaigns
readCampaignsThe workspace's campaigns, newest first: each with its broadcastId, name, status, subject, when it was sent or is due, and for a sent one how many it went to, opened and clicked, its open and click rates, the A/B subject test's winner, and which campaign it was a resend of. status keeps one kind. next gives more. Opens are an estimate: some inboxes open every email to scan it.
Only for a workspace with subscribed email contacts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| cursor | No | For the next page: the `next` value the previous page returned. Leave it out for the first page. | |
| status | No | Only campaigns in this state | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | ||
| campaigns | Yes |