Pipeline view: forecast metrics + deals

GET/api/v1/o2c/deals/pipeline

Stage-weighted pipeline forecast metrics (computed over all open deals) plus a filtered, paginated deals page with effective_stage computed server-side (deal.stage, or the linked order's live status once converted).

Operation ID: get_pipeline_api_v1_o2c_deals_pipeline_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

stagestring: Filter the deals page by stage.
is_expansionboolean: Filter the deals page by new-customer vs. expansion.
cursorstring: Pagination cursor
limitintegerdefault: 50: Page size
sort_bystring: Column to sort by.
descendingbooleandefault: True: Sort direction.

Responses

200Successful Response

Schema: SuccessEnvelope_PipelineResponse_

successboolean
messagestring
codestring
dataPipelineResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/o2c/deals/pipeline

bash

curl -X GET 'https://api.ondayzero.com/api/v1/o2c/deals/pipeline' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'