List opportunities

GET

/opportunities

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

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?createdByType=Online&includeCount=true' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "meta": {
        "totalRecords": 0,
        "serverTime": "string"
    },
    "pagination": {
        "hasMore": true,
        "nextCursor": 0,
        "prevCursor": 0
    },
    "data": [
        {
            "id": "string",
            "createdOnDateTime": "2019-08-24T14:15:22.123Z",
            "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
            "propertyID": 0,
            "type": "opportunity",
            "description": "string",
            "salesPersonID": 0,
            "status": "string",
            "pipeline": "string",
            "pipelineID": 0,
            "stageID": 0,
            "customerContactID": 0,
            "userGroupID": 0,
            "siteContactID": 0,
            "reportingLineID": 0,
            "businessUnitID": 0,
            "links": {
                "self": "string",
                "property": "string",
                "proposal": "string"
            }
        }
    ]
}

Modified at 2026-09-15 11:08:36

List opportunity stages

Opportunities