Get Opportunity | Coperniq API

const url = 'https://api.coperniq.io/v1/opportunities/1';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "title": "string",
  "description": "string",
  "address": [
    "string"
  ],
  "isActive": true,
  "primaryEmail": "string",
  "primaryPhone": "string",
  "number": 1,
  "custom": {},
  "trades": [
    "string"
  ],
  "value": 1.1,
  "size": 1.1,
  "confidence": 1.1,
  "workflowId": 1,
  "accountId": 1,
  "createdById": 1,
  "geoLocation": [
    "string"
  ],
  "imageUrl": "string",
  "streetViewUrl": "string",
  "city": "string",
  "zipcode": "string",
  "state": "string",
  "street": "string",
  "phase": {
    "id": 1,
    "name": "string",
    "type": "string"
  },
  "phaseInstances": [
    {
      "id": 1,
      "name": "string",
      "status": "NOT_STARTED",
      "position": 1,
      "type": "string",
      "phaseTemplateId": 1,
      "phaseTemplate": {
        "id": 1,
        "name": "string",
        "type": "string",
        "redSla": 1,
        "yellowSla": 1
      }
    }
  ],
  "owner": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "avatarUrl": "string"
  },
  "salesRep": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "avatarUrl": "string"
  },
  "projectManager": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "avatarUrl": "string"
  },
  "jurisdiction": {
    "id": 1,
    "name": "string",
    "uuid": "string"
  },
  "lastActivity": "2024-01-15T09:30:00Z",
  "phaseId": 1,
  "workflowName": "string"
}

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.

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdintegerRequired

Opportunity identifier

Query parameters

include_virtual_propertiesbooleanOptionalDefaults to false

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

include_archivedbooleanOptionalDefaults to false

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

Response

Opportunity details

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Record title/name

descriptionstring or null

Record description

addresslist of strings

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

isActiveboolean

Whether the record is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Sequential opportunity number

custommap from strings to any

Custom fields

tradeslist of strings

Array of trade types

valuedouble or null

Deal value

sizedouble or null

Deal size

confidencedouble or null

Deal confidence score (0-100)

workflowIdinteger or null

Associated workflow ID

accountIdinteger or null

Associated account ID

createdByIdinteger

Identifier of the user who created the opportunity

geoLocationlist of strings

Latitude/Longitude in “lat,lon” format

imageUrlstring or null

Image URL for the opportunity

streetViewUrlstring or null

Street view image URL

citystring

zipcodestring

statestring

streetstring

phaseobject or null

phaseInstanceslist of objects

Ordered list of phase instances for the opportunity

ownerobject or null

salesRepobject or null

projectManagerobject or null

jurisdictionobject or null

lastActivitystring or nullformat: "date-time"

phaseIdinteger or null

workflowNamestring

Name of the associated workflow.

Errors

401

Unauthorized Error

404

Not Found Error