Developer docsPartner API

List leads

Lists active leads for incremental CRM sync.

Bearer API key · Scope: leads.read

Endpoint

GET/api/v1/leads

Query parameters9 parameters

source
string
—
medium
string
—
campaign
string
—
from
string:date-time
Inclusive updated_at lower bound for incremental sync.
to
string:date-time
Inclusive updated_at upper bound for incremental sync.
status_stage_id
string
—
search
string
—
cursor
string
Opaque cursor returned by list/export responses. Send it back unchanged; malformed cursors return 400.
limit
integer
—

Responses

200Active leads page.

Headers

X-RateLimit-LimitMaximum requests allowed in the current window.
X-RateLimit-RemainingRequests remaining in the current window.
X-RateLimit-ResetISO timestamp when the current rate-limit window resets.

application/json

LeadListResponse

400Request payload, query, or required header is invalid.

application/json

401Missing, malformed, revoked, deleted, or unknown API key.

Headers

WWW-AuthenticateDocumented response header

application/json

403API key lacks the required scope or the workspace is not active.

application/json

429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

X-RateLimit-LimitMaximum requests allowed in the current window.
X-RateLimit-RemainingRequests remaining in the current window.
X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
Retry-AfterSeconds until the caller should retry.

application/json

500Internal authentication or server error.

application/json

Try it out