List deals

GET/api/v1/o2c/deals

List pipeline deals for the business with stage / expansion / text-search filters and cursor pagination. Always returns the total matching count alongside the page.

Operation ID: list_deals_api_v1_o2c_deals_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 by exact deal stage.
is_expansionboolean: Filter by new-customer (false) vs. expansion (true).
searchstring: Case-insensitive search across name / prospect / contact.
cursorstring: Pagination cursor
limitintegerdefault: 50: Page size
sort_bystring: Column to sort by.
descendingbooleandefault: True: Sort direction.

Responses

200Successful Response

Schema: SuccessEnvelope_DealsListResponse_

successboolean
messagestring
codestring
dataDealsListResponse

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

bash

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