Opportunities

Developing

GET

/opportunities/{opportunityID}

An Opportunity record serves as the initial stage of your sales pipeline. Think of it as a "pre-job" file, a place to track a potential lead before it officially becomes a confirmed piece of work.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200Success

application/json

Headers

Bodyapplication/json

🟠400400 Bad request

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/opportunities/7568?includeContacts=true&includeProposal=true' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "id": "string",
    "createdByType": "string",
    "createdByID": 0,
    "createdByUser": "string",
    "createdOnDateTime": "2019-08-24T14:15:22.123Z",
    "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
    "propertyID": 0,
    "type": "opportunity",
    "description": "string",
    "opportunityTemplateID": 0,
    "notes": "string",
    "skills": [
        {
            "id": 0,
            "skill": "string"
        }
    ],
    "salesPerson": {
        "firstName": "string",
        "lastName": "string",
        "landline": "string",
        "mobile": "string",
        "email": "user@example.com"
    },
    "salesPersonID": 0,
    "status": "string",
    "pipeline": "string",
    "pipelineID": 0,
    "stage": "string",
    "stageID": 0,
    "customerContact": {
        "firstName": "string",
        "lastName": "string",
        "landline": "string",
        "mobile": "string",
        "email": "user@example.com"
    },
    "customerContactID": 0,
    "assets": [
        0
    ],
    "customerReference": "string",
    "userGroup": "string",
    "userGroupID": 0,
    "tags": [
        "string"
    ],
    "siteContact": {
        "firstName": "string",
        "lastName": "string",
        "landline": "string",
        "mobile": "string",
        "email": "user@example.com"
    },
    "siteContactID": 0,
    "reportingLine": "string",
    "reportingLineID": 0,
    "businessUnit": "string",
    "businessUnitID": 0,
    "proposal": {
        "id": "string",
        "status": "string",
        "sendDateTime": "string",
        "version": 0,
        "options": {
            "cheapestSalesPrice": 0,
            "mostExpensiveSalesPrice": 0
        }
    },
    "wonSalesPrice": 0,
    "links": {
        "self": "string",
        "property": "string",
        "proposal": "string"
    }
}

Modified at 2026-06-17 11:15:52

List opportunities

Opportunities