Search

GET

/search

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

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/search?q=testuserabc123%40gmail.com&type=properties' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "type": "string",
    "propertyID": 0,
    "customerType": 0,
    "jobID": 0,
    "opportunityID": 0,
    "description": "string",
    "customerName": "string",
    "customerContactID": 0,
    "customerReferenceID": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "town": "string",
    "postcode": "string",
    "postcodeWithoutSpace": "string",
    "contact": {
        "email": "string",
        "telephone": "string"
    },
    "status": "string",
    "parentPropertyID": 0,
    "county": "string",
    "workAddressCustomer": {
        "id": 0,
        "customerName": "string"
    },
    "customerContact": {
        "contactID": 0,
        "fullName": "string"
    },
    "isServiceJob": true,
    "proposalStatus": "string",
    "stageID": 0
}

Modified at 2026-09-21 07:57:15

Scheduled activities

List opportunity pipelines