Skip to main content
GET
List leads

Authorizations

x-api-key
string
header
default:bd_live_your_key_here
required

Query Parameters

campaignId
string

Filter by campaign ID

listId
string

Filter by list ID

campaignStatus
enum<string>

Filter by status within the campaign

Available options:
CREATED,
ACTIVE,
PAUSED,
ERROR,
ARCHIVED,
COMPLETED
replied
boolean

Filter to leads that have / have not replied

unread
boolean

Filter to leads with / without an unread reply

skipped
boolean

Filter to leads that were / were not skipped

skippedReason
enum<string>

Filter by skip reason

Available options:
DUPLICATE_IN_ANOTHER_CAMPAIGN_AT_IMPORT,
DUPLICATE_IN_ANOTHER_TEAM_CAMPAIGN_AT_IMPORT
limit
object

Maximum number of leads to return (1-100)

cursor
string

Cursor from a previous response, to fetch the next page

Response

data
object[]
required
nextCursor
string | null
required

Opaque cursor for the next page; null when there are no more results. Pass it back as the cursor query parameter.