Sign in
Leads - Admin

List leads with filters

get/api/leads

Query parameters

team_idinteger nullable

Filter by attribution funnel (legacy single; matches Z_Leads.teams_id)

Filter by attribution funnel (legacy single; matches Z_Leads.teams_id)

team_idsinteger[] nullable

Filter by one or more attribution funnels ('Fluxo de Atribuição') — matches leads attributed to any selected funnel (Z_Leads.teams_id), regardless of who owns them now. NOT owner membership.

Filter by one or more attribution funnels ('Fluxo de Atribuição') — matches leads attributed to any selected funnel (Z_Leads.teams_id), regardless of who owns them now. NOT owner membership.

stagestring nullable
lead_stagestring nullable
user_idinteger nullable

Filter by user (legacy single)

Filter by user (legacy single)

user_idsinteger[] nullable

Filter by one or more users — matches leads owned by any of them

Filter by one or more users — matches leads owned by any of them

scopestring nullable

'mine' = role-aware board view: the caller's own leads, plus all team leads if the caller is a team leader

'mine' = role-aware board view: the caller's own leads, plus all team leads if the caller is a team leader

lost_reasonsstring[] nullable

Filter lost leads by one or more lost_reason IDs

Filter lost leads by one or more lost_reason IDs

sortstring nullable

Sort order: 'created_desc' (newest first) or 'created_asc' (oldest first)

Sort order: 'created_desc' (newest first) or 'created_asc' (oldest first)

date_startstring nullable

Only leads created on/after this date (YYYY-MM-DD)

Only leads created on/after this date (YYYY-MM-DD)

date_endstring nullable

Only leads created on/before this date, inclusive (YYYY-MM-DD)

Only leads created on/before this date, inclusive (YYYY-MM-DD)

skipinteger
limitinteger

Headers

x-api-tokenstring nullable

Response

Successful Response

{"stackTrail":"paths:/api/leads:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes