Skip to main content
GET
List opportunities

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.

stage_id
integer

Keep only deals sitting in this pipeline stage. Ids come from GET /pipelines (stages[].id) — this is the same value POST /opportunities takes. There is no pipeline_id filter: list the pipeline's stages and filter per stage. A stage belonging to another agency matches nothing rather than erroring.

Required range: x >= 1
Example:

11

lead_id
integer

Keep only deals on this lead. Ids come from GET /leads. An id belonging to another agency matches nothing rather than erroring.

Required range: x >= 1
Example:

42

expected_close_after
string<date>

Keep only deals whose expected_close_date is on or after this date. Format is YYYY-MM-DD — a date-time is rejected here, not truncated, unlike the POST/PUT body field of the same name, which accepts one and truncates it. A wrong filter bound returns a plausible but wrong page of rows rather than an error, so this side names exactly one format. The bound is inclusive.

Example:

"2026-01-01"

expected_close_before
string<date>

Keep only deals whose expected_close_date is on or before this date. Same format and rules as expected_close_after; also inclusive, so sending both is how you ask "what closes this month".

Example:

"2026-12-31"

Response

Paginated opportunities.