Skip to main content
GET
List campaign leads

Authorizations

x-api-key
string
header
default:bd_live_your_key_here
required

Path Parameters

id
string
required

Query Parameters

campaignStatus
enum<string>

Filter leads by their status within the campaign

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

Filter to leads that have / have not replied

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.