Skip to main content
GET
List leads
Requires leads:read and the campaignId query parameter. Optional status filters by the lead’s current status; full=true requests the expanded lead shape, including contact information.

Filtering by activity

A lead’s status changes as its sequence moves on, so a lead that accepted your connection request usually no longer has the status CONNECTION_ACCEPTED. Use activity (lead had every listed event) and excludeActivity (lead had none of them) to filter by what has happened. Values: CONNECTION_SENT, CONNECTION_ACCEPTED, MESSAGE_SENT, REPLY_RECEIVED. Values can be comma-separated or repeated (activity=A&activity=B). Each lead in the response still shows its current status. Unknown values, an empty list, or the same value in both activity and excludeActivity return 400. page defaults to 1 and is limited to 1–100. limit defaults to 50 and is limited to 1–100. Use the returned pagination metadata rather than assuming an unlimited workspace-wide lead list.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Query Parameters

campaignId
string
required

Campaign ID (required)

Example:

"cmobr5lei0000u1h02ezf5itt"

status
enum<string>

Lead's current status. To find who accepted, was messaged or replied, use activity. Lead status

Available options:
PENDING,
PROCESSING,
MESSAGE_SENT,
CONNECTION_SENT,
CONNECTION_ACCEPTED,
CONNECTION_ALREADY_SENT,
REPLY_RECEIVED,
FOLLOWUP_SENT,
BLOCKED,
PROFILE_UNREACHABLE,
RATE_LIMITED,
FAILED,
SUCCESS,
UNSUBSCRIBED,
IRRELEVANT,
SKIPPED,
DONE,
MEETING_BOOKED,
OPPORTUNITY,
LIKED_POST,
MESSAGE_SCHEDULED,
CONNECTION_SCHEDULED,
LIKE_POST_SCHEDULED,
VIEW_PROFILE_SCHEDULED,
CONNECTED,
CONNECTION_WITHDRAWN,
WITHDRAWAL_SCHEDULED,
WITHDRAWAL_NOT_POSSIBLE,
NOT_CONNECTED,
ICP_MATCH,
ICP_NOT_MATCH,
PROFILE_VIEWED,
STARTED,
STOPPED,
WAITING
activity
enum<string>[]

Only leads that had every listed event, whatever their current status. Comma-separated, e.g. activity=CONNECTION_ACCEPTED&excludeActivity=REPLY_RECEIVED = accepted but not replied.

Available options:
CONNECTION_SENT,
CONNECTION_ACCEPTED,
MESSAGE_SENT,
REPLY_RECEIVED
Example:

"CONNECTION_ACCEPTED"

excludeActivity
enum<string>[]

Only leads that had none of the listed events. Comma-separated.

Available options:
CONNECTION_SENT,
CONNECTION_ACCEPTED,
MESSAGE_SENT,
REPLY_RECEIVED
Example:

"REPLY_RECEIVED"

full
boolean
default:false

Return full lead data including all dynamic fields (default: false)

Example:

true

page
number
default:1

Page number for pagination (1-indexed)

Required range: 1 <= x <= 100
limit
number
default:50

Maximum number of items to return

Required range: 1 <= x <= 100

Response

200 - application/json

List of leads

leads
object[]
required

List of leads

pagination
object
required

Pagination info