Skip to main content
GET
Pull or re-download leads

Authorizations

Authorization
string
header
required

An Intent Leads API key, e.g. il_live_ followed by 32 letters and digits. Create one on the API and CLI page of the dashboard.

Query Parameters

since
string
default:last

last (default): new leads since this consumer's last pull, moving its cursor. Or a date YYYY-MM-DD: everything exported since then (UTC), no cursor change.

lane
string

Only this lane's leads (case-insensitive). With since=last the lane has its own cursor.

consumer
string
default:default

Names the cursor for since=last, so separate jobs each get every lead. Letters, digits, ., - or _, up to 40.

Pattern: ^[A-Za-z0-9_.-]{1,40}$
limit
integer
default:1000

Leads per response, 1 to 5,000. Out-of-range values are clamped.

Required range: 1 <= x <= 5000
format
enum<string>
default:json

json (default) or csv.

Available options:
json,
csv
page
string

Date mode only: the next_page value from the previous response.

to
string<date>

Date mode only: last export date to include (YYYY-MM-DD, UTC, inclusive).

delivery
integer

Date mode only: only leads from this delivery id (see GET /api/v1/deliveries).

Required range: x >= 1
strength
enum<string>

Date mode only: medium (medium and high) or high (high only). Other values are ignored.

Available options:
medium,
high
keyword
string

Date mode only: only leads that matched this exact keyword (case-sensitive).

Response

A page of leads, as JSON or (with format=csv) a CSV file.

since
string
required

The since you sent: last or a date.

Example:

"last"

lane
string | null
required

Lane filter, or null for every lane.

count
integer
required

Leads in this response.

has_more
boolean
required

True when this response is full (count equals limit): call again for more.

next_page
string | null
required

Only with since=YYYY-MM-DD: pass as page to get the next page. Null when there are no more, and always null with since=last.

leads
object[]
required