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

{
  "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
​
pagination
object
Pagination metadata
curl "https://api.sendpilot.ai/v1/leads?campaignId=camp_xyz789&status=CONNECTION_ACCEPTED" \
  -H "X-API-Key: YOUR_API_KEY"

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

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
campaignId
string

Filter by campaign ID

​
status
enum<string>

Filter by lead status

Available options:
PENDING,
CONNECTION_SENT,
CONNECTION_ACCEPTED,
MESSAGE_SENT,
REPLY_RECEIVED,
DONE
​
page
integer
default:1

Page number

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

Items per page

Required range: 1 <= x <= 100

Response

List of leads

​
leads
object[]
required
​
pagination
object
required