Skip to main content
GET

Request

X-API-Key
string
required
Your API key
campaignId
string
required
Campaign ID to filter leads by (required)
status
string
Filter by lead status. Options: PENDING, PROCESSING, CONNECTION_SENT, CONNECTION_ACCEPTED, MESSAGE_SENT, REPLY_RECEIVED, FOLLOWUP_SENT, BLOCKED, PROFILE_UNREACHABLE, RATE_LIMITED, FAILED, SUCCESS, UNSUBSCRIBED, IRRELEVANT, SKIPPED, DONE, MEETING_BOOKED, OPPORTUNITY, LIKED_POST
full
boolean
default:"false"
Return full lead data including all dynamic fields. Set to true for complete data.
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
Use full=true to get complete lead data including all enriched fields and custom data. This is useful when you need detailed information about leads.

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