List campaigns
list_campaignsUse this when the user asks which campaigns exist or how they are doing. Returns the organization's campaigns with what each has done: people enrolled, messages sent by kind, and opens, clicks, replies and positive replies as a count and a share of messages sent. Narrow them with status, type or search; for the next page, send the page's next cursor with the same filters. Free.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_campaigns"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Only campaigns of this type. | |
| cursor | No | The `pagination.nextCursor` of the page before. Later pages keep the first page's size. | |
| search | No | Only campaigns whose name contains this text, in any case. | |
| status | No | Only campaigns in this state: `initializing` (a draft), `active`, `completed` (running, with nothing left to send), `stopped`, `paused_manual` or `initialization_failed`. | |
| pageSize | No | Items per page. |