Campaign Management
Get Campaign by ID
Retrieves comprehensive details for a specific campaign including all configuration settings, schedule, tracking prefere
GET
Retrieves comprehensive details for a specific campaign including all configuration settings, schedule, tracking preferences, AI options, and associated metadata For client API keys, additionally filters by client_id
Overview
Retrieves comprehensive details for a specific campaign including all configuration settings, schedule, tracking preferences, AI options, and associated metadata Key Features:- Automatically validates campaign ownership - returns 404 if campaign doesn’t exist or user lacks access
- Returns single campaign object with all 18 CAMPAIGN_ATTRIBUTES fields including: status, track_settings array, complete scheduler_cron_value object, sending limits, stop conditions, AI ESP matching preferences, and plain text mode
- Optionally includes campaign tags with tag IDs, names, and colors
Path Parameters
The ID of the campaign to retrieve
Query Parameters
Your SmartLead API key
Include campaign tags in the response
Response
Campaign ID
Campaign name
Campaign status (ACTIVE, PAUSED, STOPPED, ARCHIVED, DRAFTED)
ISO 8601 timestamp
Sending schedule configuration
Tracking settings (DONT_EMAIL_OPEN, DONT_LINK_CLICK)
Response Codes
Request successful
Invalid request parameters or malformed request body
Invalid or missing API key. Check your authentication.
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
Request validation failed. Check parameter types, required fields, and value constraints.
Too many requests. Please slow down and retry after the rate limit resets.
Server error occurred. Please try again or contact support if the issue persists.
API is temporarily unavailable or under maintenance. Please try again later.
