Skip to main content

​
Get Campaign

Retrieve a specific campaign by ID. Users can only access their own campaigns.
​
path
integer
required
Campaign ID
curl -X GET "https://api.example.com/api/v1/campaigns/1" \
  -H "X-API-Key: your-api-key-here"

​
Response

​
status
object
Response status information
​
code
integer
HTTP status code (200)
​
message
string
Status message
​
data
object
Campaign object
​
id
integer
Campaign ID
​
name
string
Campaign name
​
status
string
Current campaign status
​
elevenlabs_batch_call_id
string
Associated ElevenLabs batch call ID
​
recipients_count
integer
Number of recipients in the campaign
​
scheduled_at
string
ISO 8601 timestamp when campaign is scheduled (if scheduled)
​
send_immediately
boolean
Whether the campaign was sent immediately
​
created_at
string
ISO 8601 creation timestamp
{
  "status": {
    "code": 200,
    "message": "Success"
  },
  "data": {
    "id": 1,
    "name": "Q1 Product Launch Campaign",
    "status": "completed",
    "elevenlabs_batch_call_id": "batch_abc123",
    "recipients_count": 500,
    "scheduled_at": null,
    "send_immediately": true,
    "created_at": "2024-01-15T10:30:00Z"
  }
}

​
Error Responses

​
401
object
Unauthorized - Invalid or missing authentication
​
404
object
Campaign not found