Property details

Retrieve all details for a property, returns a standard JSON serialization.

Query params

Request

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

Response

{
  "id": 1,
  "name": {
    "en": "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"
        }
      },
      {
        "id": 2,
        "name": {
          "en": "Melbourne"
        }
      }
    ]
  },
  "property_type": {
    "id": 6,
    "name": {
      "en": "House"
    },
    "created_at": "2019-09-17T11:37:23.000000Z",
    "updated_at": "2019-09-17T11:37:23.000000Z"
  },
  "currency": {
    "id": 3,
    "iso_code": "AUD",
    "name": {
      "en": "Australian Dollars"
    },
    "symbol": "$",
    "html_code": "$",
    "html_entity": "$"
  },
  "policies": {
    "id": 1,
    "children_allowed": true,
    "pets_allowed": true,
    "smoking_allowed": false,
    "parties_allowed": false,
    "checkin_window": {
      "to": 23,
      "from": 15
    },
    "checkout_time": "10",
    "max_booking_window": {
      "type": "months",
      "value": "24"
    },
    "babies_allowed": true,
    "booking_category": "request_to_book",
    "min_prior_notify": 0
  },
  "rates_settings": {
    "id": 1,
    "cleaning_fee": 344,
    "security_deposit": 1000,
    "max_stay": 0
  },
  "fees": [
    {
      "id": 258,
      "amount": 79,
      "fee_type": {
        "id": 2,
        "name": {
          "en": "Property Protection Insurance"
        }
      }
    }
  ],
  "amenities": [
    {
      "id": 1,
      "name": {
        "en": "Essentials"
      },
      "amenity_group": {
        "id": 1,
        "name": {
          "en": "Common"
        }
      }
    }
  ],
  "property_rooms": [
    {
      "id": 1,
      "name": {
        "en": "Bedroom 1"
      },
      "description": null,
      "en_suite_bath": true,
      "type": "bedroom",
      "property_room_beds": [
        {
          "id": 1,
          "bed_count": 2,
          "created_at": null,
          "updated_at": null,
          "bed_type": {
            "id": 1,
            "name": {
              "en": "King bed"
            },
            "created_at": null,
            "updated_at": null
          }
        }
      ]
    }
  ],
  "images": [
    {
      "id": 9164,
      "description": {
        "en": null
      },
      "order": 0,
      "name": "22fa59d7-0fd1-40b9-9d32-23aa07084b6f.jpg",
      "thumbnail": "https://d388r9tufnc7d1.cloudfront.net/pms/property/1/image/22fa59d7-0fd1-40b9-9d32-23aa07084b6f.jpg?d=400x400x1",
      "medium": "https://d388r9tufnc7d1.cloudfront.net/pms/property/1/image/22fa59d7-0fd1-40b9-9d32-23aa07084b6f.jpg?d=800x800x0",
      "large": "https://d388r9tufnc7d1.cloudfront.net/pms/property/1/image/22fa59d7-0fd1-40b9-9d32-23aa07084b6f.jpg?d=1920x1600x0"
    }
  ]
}

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.