PlatformDocs
MCP server

list_campaigns

List the email campaigns of one website, newest first, with their status (isActive), schedule, steps (emailCampaignTemplates), health and a cached stats snapshot (statsRollup: contacted, sent, opens, clicks, replies, bounces and rates, refreshed about every 5 minutes; see computedAt).

View as Markdown

List email campaigns · Read-only

List the email campaigns of one website, newest first, with their status (isActive), schedule, steps (emailCampaignTemplates), health and a cached stats snapshot (statsRollup: contacted, sent, opens, clicks, replies, bounces and rates, refreshed about every 5 minutes; see computedAt). For exact live numbers and per-step stats of one campaign use get_campaign. websiteId comes from list_websites and is required even though the schema marks it optional. Returns emailCampaigns[], totalDocs and remaining (campaigns not yet shown). 50 campaigns per page.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringNoanyWebsite id (24 hex characters) from list_websites. Required by the server.
pagenumberNoanyPage number, starting at 1. Default 1. 50 campaigns per page.

Tool definition

What your assistant receives from tools/list:

{
  "name": "list_campaigns",
  "title": "List email campaigns",
  "annotations": {
    "title": "List email campaigns",
    "readOnlyHint": true,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website id (24 hex characters) from list_websites. Required by the server."
      },
      "page": {
        "type": "number",
        "description": "Page number, starting at 1. Default 1. 50 campaigns per page."
      }
    }
  }
}

Used in

On this page