Skip to main content
GET
List leads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string
required

The ID of the campaign.

Pattern: ^[0-9a-z]+$

Query Parameters

cursor
string

Pagination cursor. Omit to start from the beginning.

limit
integer
default:50

Maximum number of leads to return per page. Defaults to 50, maximum 100.

Required range: 1 <= x <= 100
Example:

50

stage
enum<string>

Filter leads by their campaign stage.

Available options:
pending,
ready,
ongoing,
replied,
unresponsive,
failed,
canceled

Free-text search query to filter leads by name, username, or bio.

Example:

"john"

query
object

Structured filter query for advanced filtering.

sort
object

Sort order for results. Defaults to followers descending.

Response

200 - application/json

OK

data
object[]
required
nextCursor
string | null
required

Cursor to fetch the next page. Null if there are no more results.