Skip to main content
GET
Get a campaign's leads

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Path Parameters

uuid
string
required

The campaign's UUID.

Example:

"019f2504-58b8-77ec-9c3f-54f5d6df733e"

Query Parameters

page
number
default:1
Required range: x >= 1
limit
number
default:10

Leads per page; more than 100 is read as 100.

Required range: 1 <= x <= 100

Matches the lead's email, name, city, country, company or custom fields, in any case.

Response

Campaign leads fetched successfully

message
string
required
Example:

"Campaign leads fetched successfully"

columns
object[]
required

The campaign's variables.

campaign
object
required
data
object[]
required
pagination
object
required