List leads

Returns the leads the token's user can see, newest first by default. Users who can see all
records get every lead in the company; sales users get the leads assigned to them and to the
reps they manage.

Results are paginated with page and per_page (default 25, maximum 100). Filter with q,
lead_stage_ids[], lead_types[], sales_rep_ids[] and stalled, and order with sort and
direction.

Alongside leads, the response includes stats (open, won and lost counts and the open pipeline
value across everything you can see), entered_at_by_id (when each lead entered its current
stage) and next_step_by_id (each lead's next to-do, where one exists).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Free-text search across the lead and its contact.

lead_stage_ids[]
array of strings

Only leads in these pipeline stages.

lead_stage_ids[]
lead_types[]
array of strings

Only leads of these types, retail or insurance.

lead_types[]
Allowed:
sales_rep_ids[]
array of strings

Only leads assigned to these sales reps.

sales_rep_ids[]
boolean

When present, only open leads that have not moved recently.

string
enum

The field to sort by. Leads are newest first when omitted.

Allowed:
string
enum

The sort direction, asc (default) or desc.

Allowed:
integer

The page number, starting at 1.

integer

Leads per page, default 25, maximum 100.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json