Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
curl -X GET "https://server.smartlead.ai/api/v1/campaigns/123?api_key=YOUR_API_KEY"
{
  "success": true,
  "data": {}
}
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

campaign_id
number
required
The ID of the campaign to retrieve

Query Parameters

api_key
string
required
Your SmartLead API key
include_tags
boolean
default:"false"
Include campaign tags in the response

Response

id
number
Campaign ID
name
string
Campaign name
status
string
Campaign status (ACTIVE, PAUSED, STOPPED, ARCHIVED, DRAFTED)
created_at
string
ISO 8601 timestamp
scheduler_cron_value
object
Sending schedule configuration
track_settings
array
Tracking settings (DONT_EMAIL_OPEN, DONT_LINK_CLICK)
curl -X GET "https://server.smartlead.ai/api/v1/campaigns/123?api_key=YOUR_API_KEY"

Response Codes

200
Success
Request successful
400
Bad Request
Invalid request parameters or malformed request body
401
Unauthorized
Invalid or missing API key. Check your authentication.
404
Not Found
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
422
Validation Error
Request validation failed. Check parameter types, required fields, and value constraints.
429
Rate Limit Exceeded
Too many requests. Please slow down and retry after the rate limit resets.
500
Internal Server Error
Server error occurred. Please try again or contact support if the issue persists.
503
Service Unavailable
API is temporarily unavailable or under maintenance. Please try again later.
{
  "success": true,
  "data": {}
}