Skip to main content
GET
The campaign's leads with their per-step state

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

campaignId
string
required

The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.

Query Parameters

limit
integer
default:25

Page size, 1-100 (default 25).

Required range: 1 <= x <= 100
pageNum
integer
default:1

1-based page number (default 1).

Required range: x >= 1

Free text matched case-insensitively against the lead's full name or their company name (1-200 characters); any string is accepted, and regex metacharacters are escaped for you, so it behaves as a literal substring match. A term that matches no lead returns an empty page, not an error.

Required string length: 1 - 200

Response

Success

leads
object[]
required
pagination
object
required