Skip to main content
GET
List leads

Authorizations

X-API-Key
string
header
required

Your Flozy API key. Starts with flz_live_.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:25

Results per page (max 100).

Required range: 1 <= x <= 100
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Full-text search.

status_name
string

Keep only leads with this status. Send a name from GET /lead-statuses. Names are slugified before matching, so In Progress, in-progress and in_progress are equivalent. Unlike PUT /leads/{id}/status, filtering never creates a status — an unknown name simply matches no leads.

Maximum string length: 100
Example:

"in_progress"

pipeline_id
integer

Keep only leads that have at least one opportunity in this pipeline. Leads have no pipeline of their own — the relationship runs through /opportunities, so a lead with no opportunity is never matched. Ids come from GET /pipelines; an id belonging to another agency matches nothing.

Required range: x >= 1
Example:

1

created_after
string<date>

Keep only leads created on or after this date. Format is YYYY-MM-DD — a date-time is rejected, not truncated. The bound is inclusive and compares calendar dates in the workspace timezone.

Example:

"2026-01-01"

created_before
string<date>

Keep only leads created on or before this date. Same format and rules as created_after; also inclusive, so passing the same value for both returns exactly that day.

Example:

"2026-12-31"

Response

Paginated list of leads.