CRM

List deals in the pipeline (status)

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

Trattative, newest first. Narrow by status (open, won, lost), by stage, owner or pipeline, by the customer, and by the expected close date. past_due: true is the one worth knowing: open deals whose forecast date has already gone by, which is the largest single source of an inflated pipeline. Each row carries the amount, the stage, the owner and when the next action is due. Paged with cursor.

Examples

  • What is in the pipeline right now? GET /api/v1/rest/crm/deals/status?status=open&limit=50
  • Which deals have slipped? GET /api/v1/rest/crm/deals/status?status=open&past_due=true
  • What are we closing this month? GET /api/v1/rest/crm/deals/status?status=open&close_from=2026-09-01&close_to=2026-09-30
get/api/v1/rest/crm/deals/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/crm/deals/status
  • Auth: HTTP bearer

Query parameters

querystring

Full-text over the deal title and the customer. At least two characters.

status'open' | 'won' | 'lost'

open for the live pipeline; won/lost for what has already closed.

pipeline_idstring uuid

From crm_get_deal, which names the pipeline.

stage_idstring uuid

From crm_get_deal, which lists the stages.

owner_user_idstring uuid

Whose pipeline. From custodo_whoami for your own.

party_idstring uuid

Only this customer’s deals. The anagrafica id, from anagrafiche_search_parties.

close_fromstring

Expected close on or after this day, YYYY-MM-DD.

close_tostring

Expected close on or before this day, YYYY-MM-DD.

past_dueboolean

true: only open deals already past their expected close date.

no_next_actionboolean

true: only open deals with nothing scheduled — nobody has decided what happens next.

limitinteger

Rows to return, 1–100. Default 20.

cursorstring

Opaque cursor from a previous call’s nextCursor, to continue.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.