Skip to main content
GET
Get extracted leads
Requires leads:read. offset defaults to 0 and is capped at 10,000. limit defaults to 100 and is capped at 500. Set enriched_only=true to request enriched leads only. The response includes campaign_id (the extraction job ID), leads, total, offset, limit, and has_more. It does not import those leads into an outreach campaign. Use Add Leads separately when ready.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Path Parameters

id
string
required

Campaign ID

Query Parameters

limit
number
default:100

Maximum number of items to return

Required range: 1 <= x <= 500
offset
number
default:0

Offset for pagination (0-indexed)

Required range: 0 <= x <= 10000
enriched_only
boolean

Return only leads with completed enrichment when true. Omitted or false returns all leads. Accepts true, false, 1, or 0.

Response

Leads retrieved successfully

campaign_id
string
required
leads
object[]
required
total
number
required
offset
number
required
limit
number
required
has_more
boolean
required