v1/get-property

Params

Description

Get information about specific property

Response sample

{
    "data": {
        "property_uid": "qc11106314",
        "name": "Superior Single Room with Sea View",
        "address": "402 W Georgia St, Vancouver, V6B 5A2",
        "checkin_time": "15",
        "checkout_time": "12",
        "beds": 1,
        "bedrooms": 0,
        "bathrooms": 0,
        "is_active": 1,
        "comment": null,
        "clean_hr": 1.5,
        "clean_tm": null,
        "clean_beds_k": 0,
        "clean_beds_q": 1,
        "clean_beds_d": 0,
        "clean_beds_s": 0,
        "clean_specials": null,
        "is_inbox_enabled": 1,
        "are_auto_reviews_enabled": 1,
        "ical_token": null,
        "location": {
          "country_code": "ca",
          "postal_code": "V6B 5A2",
          "lat": 49.279616,
          "lng": -123.1122527,
          "street": "402 W Georgia St",
          "city": "Vancouver"
        },
      "selected_insurance_settings": {
        "future_reservation_coverage": "newlyBookedReservations",
        "content_and_dwelling_amount": 25000,
        "bodily_insurance_amount": 500000,
        "channel_coverage": [
          "airgms"          
        ],
        "include_screening_information": true,
        "insurance_company_name": "CompanyName",
        "is_insurance_coverage_active": true
      },
        "listings": [
            "660689604_booking_6606896",
            "GHA78D5I705LYHGA_airgms_4OXKYWD7RB8KSK8GK8K4SS8K0"
        ],
        "door_access_code": null,
        "calendar_control_allowed": false,
        "currency": "CAD"
    },
    "meta": []
}

selected_insurance_settings field added to response only if requesting app have insurance-settings scope door_access_code field added to response only if requesting app have smart-locks scope calendar_control_allowed field added to response only if requesting app have pricing-management scope

If the requested property has been merged into another, an error message is returned which contains the valid propertyUid

Sample request: https://www.igms.com/api/v1/property/GSOXS92H472AFNZC?access_token=tokenstring

Sample error response:

{
    "error": {
        "message": "Property GSOXS92H472AFNZC has been merged into qc11106314. Please re-sync the list of user's properties",
        "code": 13,
        "newPropertyUid": "qc11106314"
    }
}

To get correct property details, use newPropertyUid:

https://www.igms.com/api/v1/property/qc11106314?access_token=tokenstring