Get an opportunity (tenant:crm:read)
GET /api/crm/v1/opportunities/{id}
Module: CRM · operationId: getOpportunity · Tag: Opportunities · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string (uuid) | yes | Record ID (UUID). |
Responses
- 200 The opportunity (
application/json) - 401 Missing, invalid or expired token (no body).
- 403 The token lacks the permission (
insufficient permissions) or has no active tenant. (application/json) - 404 The record does not exist in the token's tenant. (
application/json) - 500 Unexpected error; details are only logged. (
application/json)
Fields of the 200 answer:
createdAt(string (date-time), required): Creation time.customerNo(string, required): Customer number of the tenant.id(string (uuid), required): Id of the opportunity.probability(integer, required): Win probability in percent. (max 100)stage(OpportunityStage, required): Key of a stage of the tenant (listStages). The defaults arePROSPECTING,QUALIFICATION,PROPOSAL,NEGOTIATION,CLOSED_WONandCLOSED_LOST. (max length 64)tenantName(string, required): Tenant name.title(string, required): Title of the opportunity.updatedAt(string (date-time), required): Time of the last change.value(number (double), required): Expected value.addressId(string (uuid)): Masterdata address; omitted when not set.closedAt(string (date-time), read-only): Set by the server when the opportunity enters a won or lost stage, cleared when it leaves.customFields(object): Values of the tenant's opportunity fields by field key.expectedCloseDate(string (date-time)): Omitted when not set.leadId(string (uuid)): Omitted when not set.lostReason(string): Required in a lost stage, cleared when the opportunity leaves it; omitted when not set.notes(string): Omitted when not set.ownerEmail(string): Employee responsible for the opportunity; omitted when not set.
Example 200 answer:
{
"addressId": "0e2a4c6e-8a1b-4d3f-9b5d-7f9b1d3f5a7b",
"createdAt": "2026-11-04T09:15:00Z",
"customFields": {
"budget-freigegeben": true,
"entscheider": "Eva Gaßner"
},
"customerNo": "99999",
"expectedCloseDate": "2026-12-15T00:00:00Z",
"id": "7d9f1b3d-5e7a-4c9b-8f1d-5c7e9a1b3d5f",
"leadId": "5b7d9f1a-3c5e-4a7b-9d1f-3a5c7e9b1d3f",
"notes": "Acht Access Points, Controller und Ausleuchtung; Montage in der Betriebspause.",
"ownerEmail": "lena.vogel@muster-it.example",
"probability": 50,
"stage": "PROPOSAL",
"tenantName": "DEMO",
"title": "WLAN Sudhaus und Lager",
"updatedAt": "2026-11-12T16:40:00Z",
"value": 18400
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/crm/v1/opportunities/3f2b8c1e-6d4a-4f7b-9a2e-1c5d7e9f0a12' \
-H "Authorization: Bearer $ACCESS_TOKEN"