Deals

Manage deals

List Deals

get

List deals. Requires the 'deals:read' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

limitnumber · min: 1 · max: 1000Optional

The number of results to return

Default: 100

offsetnumberOptional

The number of results to skip

Default: 0

includeSummarybooleanOptional

Include the AI-generated summary of the deal

Default: false

includeDeletedbooleanOptional

Include deleted deals

Default: false

Responses

200

Response for status 200

application/json

limitnumberRequired

offsetnumberRequired

totalCountnumberRequired

500

An unknown error occurred, trying again might help.

application/json

get

/v1/deals

HTTPcURLJavaScriptPython

GET /v1/deals HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "createdAt": "2026-03-16T16:00:24.885Z",
      "updatedAt": "2026-03-16T16:00:24.885Z",
      "vendorEntityId": "text",
      "vendorEntityUrl": "text",
      "companyVendorEntityId": "text",
      "companyDomain": "text",
      "companyId": 1,
      "evaluationId": 1,
      "createdDate": "2026-03-16T16:00:24.885Z",
      "updatedDate": "2026-03-16T16:00:24.885Z",
      "deleted": true,
      "deletedDate": "2026-03-16T16:00:24.885Z",
      "name": "text",
      "pipeline": "text",
      "stage": "text",
      "amount": 1,
      "configuredAmount": 1,
      "expectedRevenue": 1,
      "probability": 1,
      "description": "text",
      "closed": true,
      "won": true,
      "closeDate": "2026-03-16T16:00:24.885Z",
      "closedLostReason": "text",
      "closedWonReason": "text",
      "nextStep": "text",
      "pilotEndDate": "2026-03-16T16:00:24.885Z",
      "pilotDurationSeconds": 1,
      "logoUrl": "text",
      "summaryUpdatedAt": "2026-03-16T16:00:24.885Z",
      "salesProcessId": 1,
      "salesProcessStageId": 1
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

Get Deal

get

Get a deal by ID or vendor entity ID. Requires the 'deals:read' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

The Opine ID or external service ID of the deal. When supplying an external service ID, the value must begin with 'eid:' (e.g. eid:1234567890)

Query parameters

includeSummarybooleanOptional

Include the AI-generated summary of the deal

Default: false

Responses

200

Response for status 200

application/json

idnumberRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

vendorEntityIdstringRequired

vendorEntityUrlstringRequired

companyVendorEntityIdstring · nullableRequired

companyDomainstring · nullableRequired

companyIdnumber · nullableRequired

evaluationIdnumber · nullableRequired

createdDatestring · date-timeRequired

updatedDatestring · date-timeRequired

deletedbooleanRequired

deletedDatestring · date-time · nullableRequired

namestringRequired

pipelinestring · nullableRequired

stagestringRequired

amountnumberRequired

configuredAmountnumber · nullableRequired

expectedRevenuenumberRequired

probabilitynumber · nullableRequired

descriptionstring · nullableRequired

closedbooleanRequired

wonbooleanRequired

closeDatestring · date-time · nullableRequired

closedLostReasonstring · nullableRequired

closedWonReasonstring · nullableRequired

nextStepstring · nullableRequired

pilotEndDatestring · date-time · nullableRequired

pilotDurationSecondsnumber · nullableRequired

logoUrlstring · nullableRequired

summaryUpdatedAtstring · date-time · nullableRequired

salesProcessIdnumber · nullableRequired

The ID of the Opine sales process associated with this deal

salesProcessStageIdnumber · nullableRequired

The ID of the current Opine sales process stage for this deal

500

An unknown error occurred, trying again might help.

application/json

get

/v1/deals/{id}

HTTPcURLJavaScriptPython

GET /v1/deals/{id} HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "createdAt": "2026-03-16T16:00:24.885Z",
  "updatedAt": "2026-03-16T16:00:24.885Z",
  "vendorEntityId": "text",
  "vendorEntityUrl": "text",
  "companyVendorEntityId": "text",
  "companyDomain": "text",
  "companyId": 1,
  "evaluationId": 1,
  "createdDate": "2026-03-16T16:00:24.885Z",
  "updatedDate": "2026-03-16T16:00:24.885Z",
  "deleted": true,
  "deletedDate": "2026-03-16T16:00:24.885Z",
  "name": "text",
  "pipeline": "text",
  "stage": "text",
  "amount": 1,
  "configuredAmount": 1,
  "expectedRevenue": 1,
  "probability": 1,
  "description": "text",
  "closed": true,
  "won": true,
  "closeDate": "2026-03-16T16:00:24.885Z",
  "closedLostReason": "text",
  "closedWonReason": "text",
  "nextStep": "text",
  "pilotEndDate": "2026-03-16T16:00:24.885Z",
  "pilotDurationSeconds": 1,
  "logoUrl": "text",
  "summaryUpdatedAt": "2026-03-16T16:00:24.885Z",
  "salesProcessId": 1,
  "salesProcessStageId": 1
}

Create Note

post

Create a note for a deal. Requires the 'deals:write' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

The Opine ID or external service ID of the deal. When supplying an external service ID, the value must begin with 'eid:' (e.g. eid:1234567890)

Body

application/json

titlestringRequired

bodyany ofOptional

The body of the note. An array of Slate nodes or a markdown string.

or

stringOptional

Responses

200

Response for status 200

application/json

idnumberRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

organizationIdnumberRequired

createdByUserIdnumber · nullableRequired

derivedFromTemplateIdnumber · nullableRequired

titlestring · nullableRequired

bodyany · nullableRequired

500

An unknown error occurred, trying again might help.

application/json

post

/v1/deals/{id}/notes

HTTPcURLJavaScriptPython

POST /v1/deals/{id}/notes HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "title": "text",
  "body": [
    {
      "type": "text",
      "children": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

{
  "id": 1,
  "createdAt": "2026-03-16T16:00:24.885Z",
  "updatedAt": "2026-03-16T16:00:24.885Z",
  "organizationId": 1,
  "createdByUserId": 1,
  "derivedFromTemplateId": 1,
  "title": "text",
  "body": null
}