opportunities

Get Opportunity

Retrieve a specific opportunity by ID

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Note: If the opportunity has no title (empty or whitespace-only), the response returns the parent account's title instead. The stored value is not modified — this is a read-time fallback only.

get/opportunities/{opportunity_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/opportunities/{opportunity_id}
  • Auth: API key in header x-api-key

Path parameters

opportunity_idinteger required

Opportunity identifier

Query parameters

include_virtual_propertiesboolean

Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.

include_archivedboolean

Whether to include archived (inactive) records in the response. By default only active records are returned.

include_contactsboolean

Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.

Response

Opportunity details

addressstring[]

An array containing a single string, which represents the full opportunity location/address.

tradesTradeType[]

Array of trade types

valuenumber double nullable

Deal value

sizenumber double nullable

Deal size

confidencenumber double nullable

Deal confidence score (0-100)

status'ACTIVE' | 'ON_HOLD' | 'WON' | 'LOST'

Status of the opportunity:

  • ACTIVE - Opportunity is open
  • ON_HOLD - Opportunity is temporarily paused
  • WON - Opportunity was won
  • LOST - Opportunity was lost
workflowIdinteger nullable

Associated workflow ID

accountIdinteger nullable

Associated account ID

geoLocationstring[]

Latitude/Longitude in "lat,lon" format. Read-only here — settable only via PATCH /sites/{id} on the linked site.

imageUrlstring nullable

Image URL for the opportunity. Read-only — not settable via this API.

streetViewUrlstring nullable

Street view image URL. Read-only — derived from geoLocation, not settable directly.

citystring
zipcodestring
statestring
streetstring
lastActivitystring date-time nullable
phaseIdinteger nullable
numberinteger

Sequential opportunity number

workflowNamestring

Name of the associated workflow.

Changes

No recorded changes to this operation across all 1 revision of this API.