CRM

Opportunity

CRM opportunity: which pipeline and stage it is in, for how much, with whom and with what probability.

Schemas: OpportunityDto, OpportunityDetailDto

{
  "opportunityId": "string",
  "identifier": "string",
  "name": "Example",
  "status": "open",
  "amount": "1234.50",
  "currency": "EUR",
  "pipelineId": "string",
  "pipelineName": "Example",
  "stageId": "string",
  "stageName": "Example",
  "stageType": "open",
  "effectiveProbability": 1,
  "weightedAmount": "1234.50",
  "daysInStage": 1,
  "expectedCloseDate": "2026-09-01T08:00:00Z",
  "contactName": "Example",
  "companyName": "Example",
  "ownerName": "Example",
  "source": "inbound_email",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "description": "string",
  "version": 1,
  "collaboratorStaffIds": [
    "string"
  ],
  "quoteIds": [
    "string"
  ],
  "stageHistory": [
    {
      "fromStageId": "string",
      "toStageId": "string",
      "toStatus": "string",
      "daysInPrevStage": 1,
      "movedAt": "2026-09-01T08:00:00Z",
      "note": "string"
    }
  ]
}

Generated from the schema

A CRM sales opportunity: which pipeline and stage it is in, for how much, with whom and with what probability. It needs the CRM add-on: without it the answer is 402 addon_required. Writes use optimistic locking: send the version you read. The detail read, GET /api/v1/crm/opportunities/{opportunityId}, adds the description, the collaborators, the linked quotes, the version and, with includeHistory=true, the stage history.

Attributes

opportunityIdstring

identifierstring

namestring

statusstring

Available options: open, won, lost

amountstring

currencystring

pipelineIdstring

pipelineNamestring

stageIdstring

stageNamestring

stageTypestring

Available options: open, won, lost

effectiveProbabilitynumber

weightedAmountstring

daysInStageinteger

expectedCloseDatestring<date-time>

contactNamestring

companyNamestring

ownerNamestring

sourcestring

Available options: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

createdAtstring<date-time>

updatedAtstring<date-time>

descriptionstringonly in the detail

versionintegeronly in the detail

Limits: min 1

collaboratorStaffIdsstring[]only in the detail

quoteIdsstring[]only in the detail

stageHistoryobject[]only in the detail

Show child attributes

stageHistory.fromStageIdstring

stageHistory.toStageIdstring

stageHistory.toStatusstring

stageHistory.daysInPrevStageinteger

stageHistory.movedAtstring<date-time>

stageHistory.notestring

Values

status: open, won, lost
stageType: open, won, lost
source: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

Returned by

GET /api/v1/crm/opportunities — List opportunities
GET /api/v1/crm/opportunities/{opportunityId} — Get an opportunity

Modified by

POST /api/v1/crm/opportunities — Create an opportunity
PATCH /api/v1/crm/opportunities/{opportunityId} — Update an opportunity
PATCH /api/v1/crm/opportunities/{opportunityId}/stage — Move an opportunity to another stage
POST /api/v1/crm/opportunities/{opportunityId}/close — Close an opportunity
POST /api/v1/crm/opportunities/{opportunityId}/links — Link a document to an opportunity

Was this page helpful?