v9

latestOpenAPI 3.1.02026-08-08435208464.3 KB
prospecting

Get Pipeline State

Get the full pipeline state for rendering the kanban view.

get/api/prospecting/pipeline

Query parameters

lightboolean

When true, omit the heavy AI-plan fields (latest_strategy / latest_draft / evidence / goal) and return small derived previews instead, for faster first card-paint. The web kanban opts in; the full fields load lazily per deal via GET /deals/{id}. Other clients (mobile) leave this false and get the full payload unchanged.

When true, omit the heavy AI-plan fields (latest_strategy / latest_draft / evidence / goal) and return small derived previews instead, for faster first card-paint. The web kanban opts in; the full fields load lazily per deal via GET /deals/{id}. Other clients (mobile) leave this false and get the full payload unchanged.

defer_annotationsboolean

When true, skip the three post-fetch annotation passes (_annotate_client_contacts / _annotate_commercial_states / _annotate_latest_activities) — the ~2.5s cost that scales with deal count. Cards still receive deal_party identity in the initial light projection, but paint without client_contacts / commercial_state / latest_activity; the caller fetches those separately via POST /pipeline/annotations. stage_totals values are 0 in this mode (no commercial_state to sum) — the frontend computes $ totals client-side once annotations land. Default unchanged: any caller that doesn't opt in (incl. mobile) gets today's exact payload.

When true, skip the three post-fetch annotation passes (_annotate_client_contacts / _annotate_commercial_states / _annotate_latest_activities) — the ~2.5s cost that scales with deal count. Cards still receive deal_party identity in the initial light projection, but paint without client_contacts / commercial_state / latest_activity; the caller fetches those separately via POST /pipeline/annotations. stage_totals values are 0 in this mode (no commercial_state to sum) — the frontend computes $ totals client-side once annotations land. Default unchanged: any caller that doesn't opt in (incl. mobile) gets today's exact payload.

user_idstring nullable
org_idstring nullable

Response

Successful Response

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