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

{
  "campaigns": [
    {
      "id": "clxxx123456",
      "name": "Q1 Tech Founders Outreach",
      "status": "started",
      "totalLeads": 150,
      "connectionsSent": 120,
      "messagesSent": 85,
      "repliesReceived": 15,
      "createdAt": "2024-02-20T10:00:00.000Z",
      "updatedAt": "2024-02-24T15:30:00.000Z"
    },
    {
      "id": "clxxx789012",
      "name": "SaaS Decision Makers",
      "status": "paused",
      "totalLeads": 75,
      "connectionsSent": 50,
      "messagesSent": 30,
      "repliesReceived": 5,
      "createdAt": "2024-02-18T09:00:00.000Z",
      "updatedAt": "2024-02-23T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2,
    "totalPages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendpilot.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Request

​
X-API-Key
string
required
Your API key
​
status
string
Filter by campaign status. Options: all, active, paused, draft, finished
​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"20"
Number of items per page (max: 100)

​
Response

​
campaigns
array
Array of campaign objects
​
pagination
object
Pagination metadata
curl https://api.sendpilot.ai/v1/campaigns \
  -H "X-API-Key: YOUR_API_KEY"

{
  "campaigns": [
    {
      "id": "clxxx123456",
      "name": "Q1 Tech Founders Outreach",
      "status": "started",
      "totalLeads": 150,
      "connectionsSent": 120,
      "messagesSent": 85,
      "repliesReceived": 15,
      "createdAt": "2024-02-20T10:00:00.000Z",
      "updatedAt": "2024-02-24T15:30:00.000Z"
    },
    {
      "id": "clxxx789012",
      "name": "SaaS Decision Makers",
      "status": "paused",
      "totalLeads": 75,
      "connectionsSent": 50,
      "messagesSent": 30,
      "repliesReceived": 5,
      "createdAt": "2024-02-18T09:00:00.000Z",
      "updatedAt": "2024-02-23T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 2,
    "totalPages": 1
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
status
enum<string>

Filter by campaign status

Available options:
active,
paused,
draft,
finished,
all
​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

List of campaigns

​
campaigns
object[]
required
​
pagination
object
required