Opine
  • Welcome to Opine
  • Key concepts
  • Guides
    • Getting started
      • Account setup
      • Connect your tools
      • Product tour
        • Workbench
        • Deals
        • Plans
        • Plan Templates
        • Criteria Library
        • Requests
      • Conclusion
    • How to run your first evaluation
      • Create a plan
      • Customize the plan
      • Connect Slack channels
      • Share the Plan
      • Track Plan progress
      • Use Opine AI
      • AI Document Generation
    • How to set your team up for success with the Library
      • Defining Success Criteria
      • Building your Library
      • Creating Templates
      • Creating Plays
      • Criteria Metrics
      • Conclusion
  • Security
    • SAML
  • Integrations
    • Clari
    • Gong
    • Google Calendar
    • HubSpot
    • Jira
    • Linear
    • Salesforce
    • Slack
    • Microsoft Teams
    • Zoom
  • API
    • Overview
    • API Reference
      • Deals
      • Evaluations
      • Invitations
      • Organization
      • Users
Powered by GitBook
On this page
  1. API
  2. API Reference

Deals

Manage deals

PreviousAPI ReferenceNextEvaluations

Last updated 1 month ago

List Deals

get

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

Authorizations
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
500
An unknown error occurred, trying again might help.
application/json
get
GET /v1/deals HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "pilotResult": "TECH_WIN",
      "id": 1,
      "createdAt": "2025-05-31T23:40:09.487Z",
      "updatedAt": "2025-05-31T23:40:09.487Z",
      "organizationId": 1,
      "createdByUserId": 1,
      "integrationInstallationId": 1,
      "vendorEntityId": "text",
      "vendorEntityUrl": "text",
      "companyVendorEntityId": "text",
      "companyDomain": "text",
      "evaluationId": 1,
      "createdDate": "2025-05-31T23:40:09.487Z",
      "updatedDate": "2025-05-31T23:40:09.487Z",
      "deleted": true,
      "deletedDate": "2025-05-31T23:40:09.487Z",
      "name": "text",
      "pipeline": "text",
      "stage": "text",
      "amount": 1,
      "expectedRevenue": 1,
      "probability": 1,
      "description": "text",
      "closed": true,
      "won": true,
      "closeDate": "2025-05-31T23:40:09.487Z",
      "closedLostReason": "text",
      "closedWonReason": "text",
      "nextStep": "text",
      "stageHistory": "text",
      "pilotEndDate": "2025-05-31T23:40:09.487Z",
      "pilotDurationSeconds": 1,
      "latestStageVendorEntityIdBeforeClosedLost": "text",
      "logoUrl": "text",
      "summary": "text",
      "summaryUpdatedAt": "2025-05-31T23:40:09.487Z"
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

Get Deal

get

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

Authorizations
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
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
Responses
200
Response for status 200
application/json
500
An unknown error occurred, trying again might help.
application/json
get
GET /v1/deals/{id} HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "pilotResult": "TECH_WIN",
  "id": 1,
  "createdAt": "2025-05-31T23:40:09.487Z",
  "updatedAt": "2025-05-31T23:40:09.487Z",
  "organizationId": 1,
  "createdByUserId": 1,
  "integrationInstallationId": 1,
  "vendorEntityId": "text",
  "vendorEntityUrl": "text",
  "companyVendorEntityId": "text",
  "companyDomain": "text",
  "evaluationId": 1,
  "createdDate": "2025-05-31T23:40:09.487Z",
  "updatedDate": "2025-05-31T23:40:09.487Z",
  "deleted": true,
  "deletedDate": "2025-05-31T23:40:09.487Z",
  "name": "text",
  "pipeline": "text",
  "stage": "text",
  "amount": 1,
  "expectedRevenue": 1,
  "probability": 1,
  "description": "text",
  "closed": true,
  "won": true,
  "closeDate": "2025-05-31T23:40:09.487Z",
  "closedLostReason": "text",
  "closedWonReason": "text",
  "nextStep": "text",
  "stageHistory": "text",
  "pilotEndDate": "2025-05-31T23:40:09.487Z",
  "pilotDurationSeconds": 1,
  "latestStageVendorEntityIdBeforeClosedLost": "text",
  "logoUrl": "text",
  "summary": "text",
  "summaryUpdatedAt": "2025-05-31T23:40:09.487Z"
}
  • GETList Deals
  • GETGet Deal
  • POSTCreate Note

Create Note

post

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

Authorizations
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
titlestring · min: 1 · max: 512Required

The title of the note.

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
500
An unknown error occurred, trying again might help.
application/json
post
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": "2025-05-31T23:40:09.487Z",
  "updatedAt": "2025-05-31T23:40:09.487Z",
  "organizationId": 1,
  "createdByUserId": 1,
  "title": "text",
  "body": "text"
}