Skip to main content
GET
/
v1
/
campaigns
/
{id}
curl https://api.sendpilot.ai/v1/campaigns/clxxx123456 \
  -H "X-API-Key: YOUR_API_KEY"

{
  "id": "clxxx123456",
  "name": "Q1 Tech Founders Outreach",
  "status": "STARTED",
  "totalLeads": 150,
  "metrics": {
    "connectionsSent": 120,
    "connectionsAccepted": 45,
    "messagesSent": 40,
    "repliesReceived": 12
  },
  "createdAt": "2024-02-20T10:00:00.000Z",
  "updatedAt": "2024-02-24T15:30:00.000Z"
}

​
Request

​
X-API-Key
string
required
Your API key
​
id
string
required
The campaign ID

​
Response

​
id
string
Unique campaign identifier
​
name
string
Campaign name
​
status
string
Current campaign status: STARTED, PAUSED, DRAFT, FINISHED
​
totalLeads
integer
Total number of leads in the campaign
​
metrics
object
Campaign performance metrics
​
createdAt
string
ISO 8601 timestamp of when the campaign was created
​
updatedAt
string
ISO 8601 timestamp of when the campaign was last updated
curl https://api.sendpilot.ai/v1/campaigns/clxxx123456 \
  -H "X-API-Key: YOUR_API_KEY"

{
  "id": "clxxx123456",
  "name": "Q1 Tech Founders Outreach",
  "status": "STARTED",
  "totalLeads": 150,
  "metrics": {
    "connectionsSent": 120,
    "connectionsAccepted": 45,
    "messagesSent": 40,
    "repliesReceived": 12
  },
  "createdAt": "2024-02-20T10:00:00.000Z",
  "updatedAt": "2024-02-24T15:30:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Campaign ID

Response

Campaign details

​
id
string
required
​
name
string
required
​
status
enum<string>
required
Available options:
started,
paused,
draft,
finished
​
totalLeads
integer
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
connectionsSent
integer
​
messagesSent
integer
​
repliesReceived
integer
​
description
string | null
​
type
string
​
linkedInSenderIds
string[]