ConnfigConnfig Docs
Tool Reference

Campaign Read Tools

MCP tools for reading email campaigns, templates, send history, and mail quota usage.

Overview

The tools on this page are for reading your email campaigns; none of them modify data or send email. All of them require the campaigns feature on your subscription, and the workspace_id parameter is mandatory.

See Campaign Write Tools for creating and controlling campaigns, and Campaign Extras for template management and test emails.

Tools

list_campaigns

Lists email campaigns in a workspace with status and recipient progress counts (pending / scheduled / sent / failed).

Key parameters:

ParameterTypeRequiredDescription
workspace_idUUIDYesWorkspace ID
statusenumNoFilter by status: draft, running, paused, completed, cancelled
limitnumberNoMax rows to return (1–200, default 50)
offsetnumberNoRows to skip (pagination)

Say this to your AI: "List my currently running campaigns and show how many recipients have been sent in each."

get_campaign

Fetches one campaign with full metadata and a recipient status breakdown. It does not include the full recipient list; only the first 500 characters of the body HTML are returned as a preview.

Key parameters:

ParameterTypeRequiredDescription
workspace_idUUIDYesWorkspace ID
campaign_idUUIDYesCampaign ID

Say this to your AI: "Open the details of the November promo campaign — how many recipients are still pending?"

list_campaign_templates

Lists the saved email templates for a workspace (name, subject, segments).

Key parameters:

ParameterTypeRequiredDescription
workspace_idUUIDYesWorkspace ID
limitnumberNoMax rows (1–200, default 50)
offsetnumberNoRows to skip

Say this to your AI: "List my saved campaign templates, most recently updated first."

get_mail_usage

Returns rolling 30-day email sending usage compared against the plan limit. Usage is billed to the workspace owner.

Key parameters:

ParameterTypeRequiredDescription
workspace_idUUIDYesWorkspace ID

Say this to your AI: "How much of my mail quota have I used this month, and how many sends do I have left?"

list_sending_domains

Lists the sending domains available to this workspace (the owner's verified domains). Members restricted to specific domains only see those. Daily warmup limits and today's send counts are included.

Key parameters:

ParameterTypeRequiredDescription
workspace_idUUIDYesWorkspace ID

Say this to your AI: "List my sending domains — how many sends have gone out on each domain today, and what are the daily limits?"

For adding, verifying, and inspecting DNS details of domains, see Domain Tools.

get_campaign_history

Per-message send history from mail tracking: recipient, subject, campaign name, and delivery / open / click / bounce timestamps. Filterable by campaign name (partial match) and date range.

Key parameters:

ParameterTypeRequiredDescription
workspace_idUUIDYesWorkspace ID
campaign_namestringNoPartial-match filter on campaign name
startISO dateNoStart date
endISO dateNoEnd date
limitnumberNoMax rows (1–200, default 50)
offsetnumberNoRows to skip

Say this to your AI: "Of the emails sent last week, which were opened but not clicked? Break it down by campaign."