Get Campaign

Retrieve a single campaign by ID

GET /api/v1/campaigns/{id}

cURL

curl https://api.sendpilot.ai/api/v1/campaigns/clxxx123456 \
  -H "X-API-Key: YOUR_API_KEY"

200

{
  "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

Show Metrics Object

connectionsSent · integer

Number of connection requests sent

connectionsAccepted · integer

Number of connections accepted

messagesSent · integer

Number of messages sent

repliesReceived · integer

Number of replies received

createdAt · string

ISO 8601 timestamp of when the campaign was created

updatedAt · string

ISO 8601 timestamp of when the campaign was last updated

cURL

curl https://api.sendpilot.ai/api/v1/campaigns/clxxx123456 \
  -H "X-API-Key: YOUR_API_KEY"

200

{
  "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"
}