Properties list

List all properties available to the authenticated partner. Returns standard JSON serialization.

get

/rest/partners/properties

Query params

Name	Type	Mandatory	Description
limit	integer	no	integer [default 100], number of records to be returned per page
page	integer	no	integer [default 1], the number of page you want to retrieve in case there are more properties in list than the limit

Request

GET /rest/partners/properties HTTP/1.1
Host: {HOST}
Content-Type: application/json
Accept: application/json
Authorization: Basic {BASE64_BASIC_AUTH}

Response

{
    "data": [
        {
            "id": 1,
            "name": {
                "en": "My awesome property"
            },
            "bedrooms": 3,
            "toilets": 0,
            "bathrooms": 2,
            "max_occupancy": 7,
            "registration_number": null,
            "address": "Global address",
            "postcode": "3141",
            "geo": {
                "lat": -37.8439143,
                "lon": 144.9844098999
            },
            "short_description": {
                "en": "This beautiful property is packed to the rafters with special features.\r"
            },
            "description": {
                "en": "This beautiful property is packed to the rafters with special features."
            },
            "house_rules": null,
            "surroundings": null,
            "show_exact_address": true,
            "home_truths": {
                "en": "Bedroom #1: Queen bed w/ ensuite (bath)\nBedroom #2: King bed\nBedroom #3: Queen bed\nFamily bathroom : Shower\nPrivate swimming pool Solar Heated \n1x Off-streeet car park (driveway)\n\n"
            },
            "checkin_category": "doorman_entry",
            "unique_benefits": null,
            "ical_url": "URL",
            "location": {
                "id": 3,
                "name": {
                    "en": "South Yarra"
                },
                "ancestors": [
                    {
                        "id": 1,
                        "name": {
                            "en": "Victoria"
                        }
                    }
                ]
            },
            "property_type": {
                "id": 6,
                "name": {
                    "en": "House"
                }
            },
            "currency": {
                "id": 3,
                "iso_code": "AUD",
                "name": {
                    "en": "Australian Dollars"
                },
                "symbol": "$",
                "html_code": "$",
                "html_entity": "$"
            }
        }
    ],
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 100,
    "to": 1,
    "total": 1
}

Going live

Before you go live with your integration, we recommend contacting our support team.

Support & feedback

Need help integrating with Content API? The experts in our support team are here to help. Contact us at contact@rentalwise.com.