Sign in
SalesOpportunities

Get a sales opportunity

Retrieve the details of a single sales opportunity (required scope finance:read)

get/v1/finance/salesOpportunities/{salesOpportunityId}

Path parameters

salesOpportunityIdinteger required

The unique identifier of the sales opportunity

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the sales opportunity

contactIdinteger

The identifier of the contact associated with the sales opportunity

subjectstring

The subject of the sales opportunity

status'created' | 'onHold' | 'completedWon' | 'completedLost'

Represents the status of a sales opportunity.<p>Possible values:</p><ul><li><b>created</b>: The sales opportunity has been created.</li><li><b>onHold</b>: The sales opportunity is on hold.</li><li><b>completedWon</b>: The sales opportunity has been completed and won.</li><li><b>completedLost</b>: The sales opportunity has been completed and lost.</li></ul>

dueAtstring date-time nullable

The due date of the sales opportunity

stageIdinteger

The identifier of the stage associated with the sales opportunity

probabilityIdinteger

The identifier of the probability associated with the sales opportunity

ownerIdinteger

The identifier of the owner of the sales opportunity

ownerNamestring

The name of the owner of the sales opportunity

notesstring nullable

Notes associated with the sales opportunity

referencestring nullable

The reference for the sales opportunity

createdAtstring date-time

The date the sales opportunity was created

Example response

{
  "id": 12345,
  "contactId": 67890,
  "subject": "New office equipment deal",
  "status": "created",
  "dueAt": "2025-06-30T00:00:00.0000000+00:00",
  "stageId": 3,
  "probabilityId": 2,
  "ownerId": 456,
  "ownerName": "Jane Smith",
  "notes": "Customer is interested in bulk pricing",
  "reference": "SO-2025-001",
  "createdAt": "2025-01-15T09:30:00.0000000+00:00",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}