List Leads

Retrieve leads with optional filtering by campaign and status

GET /api/v1/leads

cURL

curl "https://api.sendpilot.ai/api/v1/leads?campaignId=camp_xyz789&status=CONNECTION_ACCEPTED" \
  -H "X-API-Key: YOUR_API_KEY"

200

{
  "leads": [
    {
      "id": "lead_abc123",
      "linkedinUrl": "https://www.linkedin.com/in/john-doe",
      "status": "CONNECTION_ACCEPTED",
      "firstName": "John",
      "lastName": "Doe",
      "title": "VP of Engineering",
      "company": "TechCorp",
      "campaignId": "camp_xyz789",
      "createdAt": "2024-02-20T10:00:00.000Z",
      "updatedAt": "2024-02-23T15:30:00.000Z"
    }
  ],
  "pagination": {
    "total": 45,
    "page": 1,
    "limit": 50,
    "totalPages": 1
  }
}

Request

X-API-Key · string · required

Your API key

campaignId · string

Filter by specific campaign ID

status · string

Filter by lead status. Options: PENDING, CONNECTION_SENT, CONNECTION_ACCEPTED, MESSAGE_SENT, REPLY_RECEIVED, DONE

page · integer · default: "1"

Page number for pagination

limit · integer · default: "50"

Number of items per page (max: 100)

Response

leads · array

Array of lead objects

Show Lead Object

id · string

Unique lead identifier

linkedinUrl · string

LinkedIn profile URL of the lead

status · string

Current lead status

firstName · string

Lead’s first name (if available)

lastName · string

Lead’s last name (if available)

title · string

Lead’s job title (if available)

company · string

Lead’s company (if available)

campaignId · string

The campaign this lead belongs to

createdAt · string

ISO 8601 timestamp when the lead was added

updatedAt · string

ISO 8601 timestamp of last update

pagination · object

Pagination metadata

Show Pagination Object

total · integer

Total number of leads

page · integer

Current page number

limit · integer

Items per page

totalPages · integer

Total number of pages

cURL

curl "https://api.sendpilot.ai/api/v1/leads?campaignId=camp_xyz789&status=CONNECTION_ACCEPTED" \
  -H "X-API-Key: YOUR_API_KEY"

200

{
  "leads": [
    {
      "id": "lead_abc123",
      "linkedinUrl": "https://www.linkedin.com/in/john-doe",
      "status": "CONNECTION_ACCEPTED",
      "firstName": "John",
      "lastName": "Doe",
      "title": "VP of Engineering",
      "company": "TechCorp",
      "campaignId": "camp_xyz789",
      "createdAt": "2024-02-20T10:00:00.000Z",
      "updatedAt": "2024-02-23T15:30:00.000Z"
    }
  ],
  "pagination": {
    "total": 45,
    "page": 1,
    "limit": 50,
    "totalPages": 1
  }
}