get_campaign
Read-only
Retrieve detailed campaign information including sequences, schedules, sender accounts, tracking settings, and status statistics from the Instantly.ai email outreach platform.
Instructions
Get campaign details: config, sequences, schedules, sender accounts, tracking, status.
Returns comprehensive campaign information including:
Email sequences and their content
Schedule configuration
Sender account assignments
Tracking settings (opens, clicks)
Campaign status and statistics
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- The main execution handler for the 'get_campaign' tool. Fetches detailed campaign information from the Instantly API using the provided campaign_id and returns it as formatted JSON.
async def get_campaign(params: GetCampaignInput) -> str: """ Get campaign details: config, sequences, schedules, sender accounts, tracking, status. Returns comprehensive campaign information including: - Email sequences and their content - Schedule configuration - Sender account assignments - Tracking settings (opens, clicks) - Campaign status and statistics """ client = get_client() result = await client.get(f"/campaigns/{params.campaign_id}") return json.dumps(result, indent=2) - Pydantic input schema for the get_campaign tool, defining the required 'campaign_id' parameter.
class GetCampaignInput(BaseModel): """Input for getting campaign details.""" model_config = ConfigDict(str_strip_whitespace=True, extra="ignore") campaign_id: str = Field(..., description="Campaign UUID") - src/instantly_mcp/server.py:79-79 (registration)MCP tool registration annotation specifying that 'get_campaign' is read-only.
"get_campaign": {"readOnlyHint": True}, - src/instantly_mcp/tools/campaigns.py:517-526 (registration)The CAMPAIGN_TOOLS list that includes the get_campaign function, used by the server for tool collection and registration.
CAMPAIGN_TOOLS = [ create_campaign, list_campaigns, get_campaign, update_campaign, activate_campaign, pause_campaign, delete_campaign, search_campaigns_by_contact, ]