List properties

Developing

GET

/properties

A property is either a customer or work site. It represents an address where assets, contracts, opportunities or jobs can be recorded. The list properties end point will return a list of properties.

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 '/properties' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "meta": {
        "totalRecords": 0,
        "serverTime": "string"
    },
    "pagination": {
        "hasMore": true,
        "nextCursor": 0,
        "prevCursor": 0
    },
    "data": [
        {
            "id": 0,
            "createdOnDateTime": "2019-08-24T14:15:22.123Z",
            "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
            "type": "customer",
            "customerType": 0,
            "parentPropertyID": 0,
            "status": "active",
            "contact": {
                "id": "string",
                "title": "string",
                "firstName": "string",
                "lastName": "string",
                "telephone": "string",
                "mobile": "string",
                "email": "string"
            },
            "companyName": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "town": "string",
            "province": "string",
            "provinceID": 0,
            "postcode": "string",
            "buildingTypeID": 0,
            "links": {
                "self": "string",
                "assets": "string",
                "contracts": "string",
                "opportunities": "string",
                "jobs": "string"
            }
        }
    ]
}

Modified at 2026-06-29 14:23:06

Support and technical support

Properties