List Campaigns

Retrieve all campaigns in your workspace

GET /api/v1/campaigns

cURL

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

200

{
  "data": [
    {
      "id": "clxxx123456",
      "name": "Q1 Tech Founders Outreach",
      "status": "STARTED",
      "totalLeads": 150,
      "createdAt": "2024-02-20T10:00:00.000Z",
      "updatedAt": "2024-02-24T15:30:00.000Z"
    },
    {
      "id": "clxxx789012",
      "name": "SaaS Decision Makers",
      "status": "PAUSED",
      "totalLeads": 75,
      "createdAt": "2024-02-18T09:00:00.000Z",
      "updatedAt": "2024-02-23T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Request

X-API-Key · string · required

Your API key

status · string

Filter by campaign status. Options: started, paused, draft, finished

page · integer · default: "1"

Page number for pagination

limit · integer · default: "20"

Number of items per page (max: 100)

Response

data · array

Array of campaign objects

Show Campaign Object

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

createdAt · string

ISO 8601 timestamp of when the campaign was created

updatedAt · string

ISO 8601 timestamp of when the campaign was last updated

meta · object

Pagination metadata

Show Meta Object

total · integer

Total number of campaigns

page · integer

Current page number

limit · integer

Items per page

totalPages · integer

Total number of pages

cURL

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

200

{
  "data": [
    {
      "id": "clxxx123456",
      "name": "Q1 Tech Founders Outreach",
      "status": "STARTED",
      "totalLeads": 150,
      "createdAt": "2024-02-20T10:00:00.000Z",
      "updatedAt": "2024-02-24T15:30:00.000Z"
    },
    {
      "id": "clxxx789012",
      "name": "SaaS Decision Makers",
      "status": "PAUSED",
      "totalLeads": 75,
      "createdAt": "2024-02-18T09:00:00.000Z",
      "updatedAt": "2024-02-23T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}