---
updatedAt: 2026-06-30T13:39:21.000Z
agentTools:
  projectIndex: https://docs.bkbn.com/llms.txt
---

# /real-estate/fetch

Deprecated: use GET /v1/real-estate-properties/{propertyId} instead. Sunset: 2026-09-10. Retrieves details of a specific real estate property from the authenticated client's workspace. Provide either realEstateId (BKBN primary key) or objectReferenceId (internal ID) as query parameters. If both are provided, realEstateId is preferred. At least one must be provided to identify the property.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "BKBN Sync API",
    "description": "API connector for customer applications.",
    "version": "2.16.0"
  },
  "servers": [
    {
      "url": "http://sync-dev.bkbn.com",
      "description": "Generated server url"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Webhook Events",
      "description": "Event payloads BKBN POSTs to your callback URL. You receive these; you do not call them."
    },
    {
      "name": "Real Estate (Deprecated)",
      "description": "Controller for all real estate operations"
    }
  ],
  "paths": {
    "/real-estate/fetch": {
      "get": {
        "tags": [
          "Real Estate (Deprecated)"
        ],
        "description": "Deprecated: use GET /v1/real-estate-properties/{propertyId} instead. Sunset: 2026-09-10. Retrieves details of a specific real estate property from the authenticated client's workspace. Provide either realEstateId (BKBN primary key) or objectReferenceId (internal ID) as query parameters. If both are provided, realEstateId is preferred. At least one must be provided to identify the property.",
        "operationId": "fetchRealEstate",
        "parameters": [
          {
            "name": "realEstateId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "objectReferenceId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/RealEstatePropertyResponse"
                }
              }
            }
          }
        },
        "deprecated": true
      }
    }
  },
  "components": {
    "schemas": {
      "Coordinates": {
        "type": "object",
        "description": "A point on the world map, in decimal degrees (WGS 84).",
        "properties": {
          "lat": {
            "type": "number",
            "format": "double",
            "default": 0,
            "description": "Latitude in decimal degrees.",
            "example": "47.3769"
          },
          "lng": {
            "type": "number",
            "format": "double",
            "default": 0,
            "description": "Longitude in decimal degrees.",
            "example": "8.5417"
          }
        }
      },
      "MonetaryValueDTO": {
        "type": "object",
        "description": "An amount together with the currency it is expressed in.",
        "properties": {
          "amount": {
            "type": "number",
            "description": "The amount, as a decimal in the currency's major unit.",
            "example": "1250000.00"
          },
          "currency": {
            "type": "object",
            "description": "The currency of the monetary value, as an ISO 4217 code.",
            "example": "CHF",
            "properties": {
              "currencyCode": {
                "type": "string"
              },
              "displayName": {
                "type": "string"
              },
              "symbol": {
                "type": "string"
              },
              "defaultFractionDigits": {
                "type": "integer",
                "format": "int32"
              },
              "numericCode": {
                "type": "integer",
                "format": "int32"
              },
              "numericCodeAsString": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "amount",
          "currency"
        ]
      },
      "AreaDTO": {
        "type": "object",
        "description": "A surface area together with the unit it is measured in. Both parts are required.",
        "properties": {
          "value": {
            "type": "number",
            "description": "The area. Must be greater than zero.",
            "example": "142.5"
          },
          "unit": {
            "type": "string",
            "description": "Unit the area is expressed in.",
            "enum": [
              "SQM",
              "SQFT"
            ],
            "example": "SQM"
          }
        },
        "required": [
          "unit",
          "value"
        ]
      },
      "EnergyCertificateDTO": {
        "type": "object",
        "description": "The property's energy certificate. Unlike every other object here this one is merged field by field on an update: an omitted field keeps its stored value and no field can be cleared.",
        "properties": {
          "type": {
            "type": "string",
            "description": "Whether the figures are measured consumption or calculated demand.",
            "enum": [
              "CONSUMPTION",
              "DEMAND",
              "UNKNOWN"
            ],
            "example": "CONSUMPTION"
          },
          "year": {
            "type": "integer",
            "format": "int32",
            "description": "Year the certificate was issued.",
            "example": 2024
          },
          "consumption": {
            "type": "number",
            "description": "Measured energy consumption, in kWh/m²·a. Belongs to a CONSUMPTION certificate.",
            "example": "118.4"
          },
          "demand": {
            "type": "number",
            "description": "Calculated energy demand, in kWh/m²·a. Belongs to a DEMAND certificate.",
            "example": "92.0"
          },
          "validUntil": {
            "type": "string",
            "format": "date",
            "description": "Date the certificate stops being valid.",
            "example": "2034-05-31"
          },
          "energyClass": {
            "type": "string",
            "description": "Efficiency class the figures put the property in.",
            "enum": [
              "A_PLUS",
              "A",
              "B",
              "C",
              "D",
              "E",
              "F",
              "G",
              "H",
              "UNKNOWN"
            ],
            "example": "B"
          },
          "co2Emissions": {
            "type": "number",
            "description": "CO₂ emissions, in kg/m²·a.",
            "example": "23.7"
          },
          "primaryEnergySources": {
            "type": "array",
            "description": "Energy sources the property is heated and powered by, as free text.",
            "example": [
              "Fernwärme"
            ],
            "items": {
              "type": "string"
            }
          },
          "includesWarmWater": {
            "type": "boolean",
            "description": "Whether the consumption figure includes warm water."
          }
        }
      },
      "ParkingLotDTO": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Parking kind (e.g. underground-garage, open-parking-space)."
          },
          "count": {
            "type": "integer",
            "format": "int32",
            "description": "Number of such parking lots."
          },
          "price": {
            "type": "number",
            "description": "Price of the parking lot."
          },
          "listingType": {
            "type": "string",
            "description": "Whether the parking lot is for sale or rent.",
            "enum": [
              "RENT",
              "SELL"
            ],
            "example": "SELL"
          }
        },
        "required": [
          "type"
        ]
      },
      "PartyContactDTO": {
        "type": "object",
        "description": "A person attached to the property — its owner, the seller's contact or the person who shows it. Sending this object replaces the stored one outright; send it with every field empty to erase what is stored.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The person's name.",
            "example": "Sven Müller"
          },
          "email": {
            "type": "string",
            "description": "Email address to reach them on.",
            "example": "s.mueller@example.com"
          },
          "phone": {
            "type": "string",
            "description": "Phone number to reach them on.",
            "example": "+41 79 123 45 67"
          },
          "organization": {
            "type": "string",
            "description": "Organization they belong to. Only meaningful on the object owner; ignored on the two seller contacts."
          }
        }
      },
      "PropertyAddressDTO": {
        "type": "object",
        "description": "Postal address of a property. On a property update this object is merged sub-field by sub-field rather than replaced, so an omitted sub-field keeps its stored value.",
        "properties": {
          "street": {
            "type": "string",
            "description": "Street name, without the number.",
            "example": "Bahnhofstrasse"
          },
          "streetNumber": {
            "type": "string",
            "description": "House or building number, including any letter.",
            "example": "12a"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code, in the local format.",
            "example": "8001"
          },
          "city": {
            "type": "string",
            "description": "City or town.",
            "example": "Zürich"
          },
          "country": {
            "type": "string",
            "description": "Country as an ISO 3166-1 alpha-2 code.",
            "enum": [
              "CH",
              "DE",
              "AT",
              "FR",
              "LU",
              "GB",
              "HR",
              "ES",
              "BE",
              "NL",
              "IT",
              "UK",
              "XX"
            ],
            "example": "CH"
          },
          "coordinates": {
            "$ref": "#/components/schemas/Coordinates",
            "description": "Geographic position of the property. Nothing on our side geocodes the address, so without this the property is stored at (0, 0): distance-based creative routing is lost and a KEYS_PICKUP order is rejected at placement."
          },
          "streetAddition": {
            "type": "string",
            "description": "Additional address line, where the street alone is not enough."
          },
          "region": {
            "type": "string",
            "description": "Region, state or canton.",
            "example": "Zürich"
          },
          "district": {
            "type": "string",
            "description": "District or neighbourhood, where one is used locally.",
            "example": "Kreis 1"
          },
          "coordinatesElevation": {
            "type": "number",
            "description": "Elevation of the property, in metres."
          },
          "unit": {
            "type": "string",
            "description": "Unit or apartment identifier within the building.",
            "example": "3.OG links"
          }
        },
        "required": [
          "city",
          "country",
          "postalCode",
          "street",
          "streetNumber"
        ]
      },
      "PropertyBuyPricesDTO": {
        "type": "object",
        "properties": {
          "price": {
            "type": "number",
            "description": "Listing price (mirrors the deprecated top-level price). Null when not provided."
          },
          "perSquareMeter": {
            "type": "number",
            "description": "Price per square meter. Null when not provided."
          },
          "referring": {
            "type": "string",
            "description": "Reference basis for the per-square-meter price. Null when not provided.",
            "enum": [
              "ALL",
              "M2",
              "KM2",
              "UNKNOWN"
            ]
          }
        }
      },
      "PropertyCharacteristicsDTO": {
        "type": "object",
        "properties": {
          "isDemolitionProperty": {
            "type": "string",
            "description": "Whether the property is designated for demolition.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isProjection": {
            "type": "string",
            "description": "Whether the property is a projected (not yet built) property.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isFirstOccupancy": {
            "type": "string",
            "description": "Whether this is the first occupancy of the property.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isMonument": {
            "type": "string",
            "description": "Whether the property is a listed monument.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasElevator": {
            "type": "string",
            "description": "Whether the property has an elevator.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasLiftingPlatform": {
            "type": "string",
            "description": "Whether the property has a lifting platform.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasRamp": {
            "type": "string",
            "description": "Whether the property has a ramp for accessibility.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasCellar": {
            "type": "string",
            "description": "Whether the property has a cellar.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasBalcony": {
            "type": "string",
            "description": "Whether the property has a balcony.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasTerrace": {
            "type": "string",
            "description": "Whether the property has a terrace.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasLoggia": {
            "type": "string",
            "description": "Whether the property has a loggia.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasGarden": {
            "type": "string",
            "description": "Whether the property has a garden.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasAttic": {
            "type": "string",
            "description": "Whether the property has an attic.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasFireplace": {
            "type": "string",
            "description": "Whether the property has a fireplace.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasTiledStove": {
            "type": "string",
            "description": "Whether the property has a tiled stove.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSwimmingPool": {
            "type": "string",
            "description": "Whether the property has a swimming pool.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSauna": {
            "type": "string",
            "description": "Whether the property has a sauna.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasWinterGarden": {
            "type": "string",
            "description": "Whether the property has a winter garden.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasWellnessArea": {
            "type": "string",
            "description": "Whether the property has a wellness area.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasStoreRoom": {
            "type": "string",
            "description": "Whether the property has a store room.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasGardenHouse": {
            "type": "string",
            "description": "Whether the property has a garden house.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasBuiltInKitchen": {
            "type": "string",
            "description": "Whether the property has a built-in kitchen.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasAirConditioning": {
            "type": "string",
            "description": "Whether the property has air conditioning.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasAlarmSystem": {
            "type": "string",
            "description": "Whether the property has an alarm system.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isWheelchairAccessible": {
            "type": "string",
            "description": "Whether the property is wheelchair accessible.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isSmokingAllowed": {
            "type": "string",
            "description": "Whether smoking is allowed in the property.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isFlatShareSuitable": {
            "type": "string",
            "description": "Whether the property is suitable for flat-sharing.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasGrannyFlat": {
            "type": "string",
            "description": "Whether the property has a granny flat.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isSecondaryResidenceAllowed": {
            "type": "string",
            "description": "Whether secondary residence is allowed.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasCanteen": {
            "type": "string",
            "description": "Whether the property has a canteen.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasCableTv": {
            "type": "string",
            "description": "Whether the property has cable TV.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasFiberOptic": {
            "type": "string",
            "description": "Whether the property has fiber optic connectivity.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasMultimediaWiring": {
            "type": "string",
            "description": "Whether the property has multimedia wiring.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasCarPort": {
            "type": "string",
            "description": "Whether the property has a carport.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasGarage": {
            "type": "string",
            "description": "Whether the property has a garage.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasUndergroundGarage": {
            "type": "string",
            "description": "Whether the property has an underground garage.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasParking": {
            "type": "string",
            "description": "Whether the property has a parking space.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasDuplexParking": {
            "type": "string",
            "description": "Whether the property has a duplex parking system.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasMultiStoryGarage": {
            "type": "string",
            "description": "Whether the property has a multi-story garage.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasEvChargingStation": {
            "type": "string",
            "description": "Whether the property has an EV charging station.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasPhotovoltaic": {
            "type": "string",
            "description": "Whether the property has photovoltaic panels.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasThermalSolarCollector": {
            "type": "string",
            "description": "Whether the property has thermal solar collectors.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasDishwasher": {
            "type": "string",
            "description": "Whether the property has a dishwasher.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasWashingMachine": {
            "type": "string",
            "description": "Whether the property has a washing machine.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasTumbleDryer": {
            "type": "string",
            "description": "Whether the property has a tumble dryer.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSteamer": {
            "type": "string",
            "description": "Whether the property has a steamer.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasLakeView": {
            "type": "string",
            "description": "Whether the property has a lake view.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasMountainView": {
            "type": "string",
            "description": "Whether the property has a mountain view.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasNiceView": {
            "type": "string",
            "description": "Whether the property has a nice view.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasPlayground": {
            "type": "string",
            "description": "Whether the property has a playground nearby.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "supportsRemoteViewings": {
            "type": "string",
            "description": "Whether the property supports remote viewings.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "arePetsAllowed": {
            "type": "string",
            "description": "Whether pets are allowed in the property.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isChildFriendly": {
            "type": "string",
            "description": "Whether the property is child-friendly.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isQuiet": {
            "type": "string",
            "description": "Whether the property is in a quiet location.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isSunny": {
            "type": "string",
            "description": "Whether the property is in a sunny location.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isCornerHouse": {
            "type": "string",
            "description": "Whether the property is a corner house.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isMiddleHouse": {
            "type": "string",
            "description": "Whether the property is a middle house.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isGroundFloor": {
            "type": "string",
            "description": "Whether the property is on the ground floor.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isGroundFloorRaised": {
            "type": "string",
            "description": "Whether the property is on a raised ground floor.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isUnderRoof": {
            "type": "string",
            "description": "Whether the property is under the roof.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isWellTended": {
            "type": "string",
            "description": "Whether the property is well-tended.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isTemporaryUse": {
            "type": "string",
            "description": "Whether the property is for temporary use.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isOnEvenGround": {
            "type": "string",
            "description": "Whether the property is on even ground.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isOnHillside": {
            "type": "string",
            "description": "Whether the property is on a hillside.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "isOnHillsideSouth": {
            "type": "string",
            "description": "Whether the property is on a south-facing hillside.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasConnectedBuildingLand": {
            "type": "string",
            "description": "Whether the property has connected building land.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasForeignQuota": {
            "type": "string",
            "description": "Whether the property has a foreign ownership quota.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSupplyGas": {
            "type": "string",
            "description": "Whether the property has gas supply.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSupplyWater": {
            "type": "string",
            "description": "Whether the property has water supply.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSupplySewage": {
            "type": "string",
            "description": "Whether the property has sewage supply.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "hasSupplyPower": {
            "type": "string",
            "description": "Whether the property has power supply.",
            "enum": [
              "APPLIES",
              "DOES_NOT_APPLY",
              "UNKNOWN"
            ]
          },
          "numberOfCarPorts": {
            "type": "integer",
            "format": "int32",
            "description": "Number of carports available at the property."
          },
          "numberOfGarages": {
            "type": "integer",
            "format": "int32",
            "description": "Number of garages available at the property."
          }
        }
      },
      "PropertyFloorInfoDTO": {
        "type": "object",
        "description": "Which floor the property is on and how it is described locally.",
        "properties": {
          "floor": {
            "type": "string",
            "description": "The floor, as one of the recognised floor designations.",
            "enum": [
              "BASEMENT",
              "GROUND",
              "UPPER",
              "ATTIC"
            ],
            "example": "UPPER"
          },
          "description": {
            "type": "string",
            "description": "Free text shown alongside the floor, for a local label the enum has no value for.",
            "example": "Hochparterre"
          }
        },
        "required": [
          "floor"
        ]
      },
      "PropertyLocalizationDTO": {
        "type": "object",
        "description": "Marketing texts for the property in one language.",
        "properties": {
          "languageCode": {
            "type": "string",
            "description": "Language these texts are written in, as an ISO 639-1 code. Required, and unique within the list regardless of case — two entries for the same language are refused.",
            "example": "de"
          },
          "title": {
            "type": "string",
            "description": "Listing headline in this language."
          },
          "description": {
            "type": "string",
            "description": "Main listing description in this language."
          },
          "furnishingDescription": {
            "type": "string",
            "description": "Description of the furnishing and fittings."
          },
          "locationDescription": {
            "type": "string",
            "description": "Description of the location and neighbourhood."
          },
          "excerpt": {
            "type": "string",
            "description": "Short teaser used where the full description does not fit."
          },
          "otherDescription": {
            "type": "string",
            "description": "Any other remarks about the property that fit none of the texts above."
          }
        },
        "required": [
          "languageCode"
        ]
      },
      "PropertyPricesDTO": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "object",
            "description": "The single currency all price amounts of this property are denominated in.",
            "properties": {
              "currencyCode": {
                "type": "string"
              },
              "displayName": {
                "type": "string"
              },
              "symbol": {
                "type": "string"
              },
              "defaultFractionDigits": {
                "type": "integer",
                "format": "int32"
              },
              "numericCode": {
                "type": "integer",
                "format": "int32"
              },
              "numericCodeAsString": {
                "type": "string"
              }
            }
          },
          "buy": {
            "$ref": "#/components/schemas/PropertyBuyPricesDTO",
            "description": "Purchase-side prices. Null when not provided."
          },
          "rent": {
            "$ref": "#/components/schemas/PropertyRentPricesDTO",
            "description": "Rental-side prices. Null when not provided."
          },
          "deposit": {
            "type": "number",
            "description": "Deposit amount. Null when not provided."
          }
        }
      },
      "PropertyRentPricesDTO": {
        "type": "object",
        "properties": {
          "net": {
            "type": "number",
            "description": "Net rent. Null when not provided."
          },
          "gross": {
            "type": "number",
            "description": "Gross rent. Null when not provided."
          },
          "extra": {
            "type": "number",
            "description": "Extra rental costs. Null when not provided."
          },
          "interval": {
            "type": "string",
            "description": "Billing interval for the rent amounts. Null when not provided.",
            "enum": [
              "ONETIME",
              "DAY",
              "WEEK",
              "MONTH",
              "YEAR",
              "UNKNOWN"
            ]
          }
        }
      },
      "PublisherDTO": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Portal identifier (e.g. immoscout24)."
          },
          "options": {
            "type": "array",
            "description": "Portal-specific key/value options.",
            "items": {
              "$ref": "#/components/schemas/PublisherOptionDTO"
            }
          },
          "promotions": {
            "type": "array",
            "description": "Portal-specific promotion names (e.g. top-listing).",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id"
        ]
      },
      "PublisherOptionDTO": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Option key."
          },
          "value": {
            "type": "string",
            "description": "Option value."
          }
        },
        "required": [
          "key"
        ]
      },
      "SwissReferencesDTO": {
        "type": "object",
        "properties": {
          "egid": {
            "type": "string",
            "description": "EGID: federal building identifier."
          },
          "ewid": {
            "type": "string",
            "description": "EWID: federal dwelling identifier."
          },
          "egrid": {
            "type": "string",
            "description": "EGRID: land-register parcel identifier."
          },
          "minergieCertification": {
            "type": "string",
            "description": "Minergie certification.",
            "enum": [
              "MINERGIE",
              "MINERGIE_A",
              "MINERGIE_A_ECO",
              "MINERGIE_AREAL",
              "MINERGIE_ECO",
              "MINERGIE_MQS_BAU",
              "MINERGIE_MQS_BETRIEB",
              "MINERGIE_P",
              "MINERGIE_P_ECO",
              "UNKNOWN"
            ]
          }
        }
      },
      "RealEstatePropertyResponse": {
        "type": "object",
        "description": "A property as Backbone holds it. Null fields at the top level are omitted from the JSON entirely, so a field you never sent will be absent rather than null. Fields nested inside an object (a contact, the energy certificate, a localization) are not omitted and do come back as explicit nulls.",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Backbone's id for this property — the id used by `/{propertyId}`."
          },
          "createdOn": {
            "type": "string",
            "format": "date-time",
            "description": "When the property was created, UTC. Truncated to milliseconds."
          },
          "lastChanged": {
            "type": "string",
            "format": "date-time",
            "description": "When the property last saw activity, UTC. Wider than a last-modified stamp: related-entity events such as a new order or a delivery move it too, so it is not a reliable signal that the property's own fields changed. Truncated to milliseconds."
          },
          "ownerId": {
            "type": "string",
            "format": "uuid",
            "description": "Backbone id of the broker the property belongs to — the agent, not the property owner."
          },
          "title": {
            "type": "string",
            "description": "Display title of the property."
          },
          "status": {
            "type": "string",
            "description": "The free-form text you supplied as `status`, returned unchanged."
          },
          "address": {
            "$ref": "#/components/schemas/PropertyAddressDTO",
            "description": "Postal address of the property."
          },
          "floorInfo": {
            "$ref": "#/components/schemas/PropertyFloorInfoDTO",
            "description": "Which floors exist and how they are labelled."
          },
          "objectReferenceId": {
            "type": "string",
            "description": "This property's id in your own system, if one was supplied."
          },
          "ownerReferenceId": {
            "type": "string",
            "description": "Not populated — the platform does not return it, so this field is always absent. Resolve the broker from `ownerId`."
          },
          "propertyType": {
            "type": "string",
            "description": "What the property is used for. Same value you send as `propertyUsage` on create and update — the name differs here for backwards compatibility.",
            "enum": [
              "RESIDENTIAL",
              "COMMERCIAL"
            ],
            "example": "RESIDENTIAL"
          },
          "realtyType": {
            "type": "string",
            "description": "Kind of property (e.g. APARTMENT, HOUSE).",
            "enum": [
              "STUDIO",
              "APARTMENT",
              "DETACHED_HOUSE",
              "SEMI_DETACHED_HOUSE",
              "DUPLEX",
              "TERRACE",
              "TOWNHOUSE",
              "VILLA",
              "BUILDING",
              "PENTHOUSE",
              "OFFICE",
              "GYM",
              "STORE",
              "RESTAURANT",
              "STORAGE_WAREHOUSE",
              "HOTEL",
              "PLANT_INDUSTRIAL"
            ],
            "example": "APARTMENT"
          },
          "listingType": {
            "type": "string",
            "description": "Whether the property is for sale or to let.",
            "enum": [
              "RENT",
              "SELL"
            ],
            "example": "SELL"
          },
          "price": {
            "$ref": "#/components/schemas/MonetaryValueDTO",
            "description": "Asking price of the property, as supplied."
          },
          "freeTextHighlights": {
            "type": "string",
            "description": "Free-text selling points for the property."
          },
          "floorLevel": {
            "type": "integer",
            "format": "int32",
            "description": "Which floor the property itself is on."
          },
          "area": {
            "type": "number",
            "description": "Surface area of the property, in the unit given by `areaUnit`."
          },
          "areaUnit": {
            "type": "string",
            "description": "Unit `area` is expressed in (SQM or SQFT).",
            "enum": [
              "SQM",
              "SQFT"
            ],
            "example": "SQM"
          },
          "numberOfRooms": {
            "type": "number",
            "description": "Number of rooms, halves included.",
            "example": "4.5"
          },
          "numberOfUnits": {
            "type": "integer",
            "format": "int32",
            "description": "Number of separate units in the property."
          },
          "numberOfFloors": {
            "type": "integer",
            "format": "int32",
            "description": "Number of floors the property spans."
          },
          "keywords": {
            "type": "array",
            "description": "Free-form keywords, as supplied.",
            "items": {
              "type": "string"
            }
          },
          "photoshootingArea": {
            "type": "integer",
            "format": "int32",
            "description": "Area to be photographed, in square metres, as supplied."
          },
          "isFurnished": {
            "type": "boolean",
            "description": "Whether the property is furnished."
          },
          "surface": {
            "$ref": "#/components/schemas/AreaDTO",
            "description": "Surface area with its unit. Preferred over `area` / `areaUnit`."
          },
          "usableArea": {
            "type": "number",
            "description": "Usable area (Nutzfläche) in m²."
          },
          "totalArea": {
            "type": "number",
            "description": "Total area in m²."
          },
          "plotArea": {
            "type": "number",
            "description": "Plot / land area in m²."
          },
          "yearBuilt": {
            "type": "integer",
            "format": "int32",
            "description": "Year the property was built."
          },
          "yearLastRenovated": {
            "type": "integer",
            "format": "int32",
            "description": "Year of the last renovation."
          },
          "numberOfBedrooms": {
            "type": "integer",
            "format": "int32",
            "description": "Number of bedrooms."
          },
          "numberOfBathrooms": {
            "type": "integer",
            "format": "int32",
            "description": "Number of bathrooms."
          },
          "energyCertificate": {
            "$ref": "#/components/schemas/EnergyCertificateDTO",
            "description": "Energy certificate of the property."
          },
          "localizations": {
            "type": "array",
            "description": "Per-language marketing texts held for the property.",
            "items": {
              "$ref": "#/components/schemas/PropertyLocalizationDTO"
            }
          },
          "objectOwner": {
            "$ref": "#/components/schemas/PartyContactDTO",
            "description": "The property owner — the actual owner, not the agent."
          },
          "sellerOrganization": {
            "type": "string",
            "description": "Name of the selling organization."
          },
          "sellerContactPerson": {
            "$ref": "#/components/schemas/PartyContactDTO",
            "description": "Who to contact about the sale."
          },
          "sellerVisitPerson": {
            "$ref": "#/components/schemas/PartyContactDTO",
            "description": "Who accompanies viewings."
          },
          "sellerInquiryEmail": {
            "type": "string",
            "description": "Email address for seller inquiries."
          },
          "displayReferenceId": {
            "type": "string",
            "description": "Human-facing reference shown in listings and on portals.",
            "example": "A-42"
          },
          "houseReferenceId": {
            "type": "string",
            "description": "Your id of the house this property is a unit of."
          },
          "houseUnitReferenceId": {
            "type": "string",
            "description": "Your id of this specific unit within its house."
          },
          "buildingObjectId": {
            "type": "string",
            "description": "Your id of the building object."
          },
          "projectReferenceId": {
            "type": "string",
            "description": "Your id of the project (development) this property belongs to."
          },
          "parentRealtyId": {
            "type": "string",
            "format": "uuid",
            "description": "Backbone id of the parent property this one is a unit of."
          },
          "is24Id": {
            "type": "string",
            "description": "ImmobilienScout24 (IS24) object id."
          },
          "mainLanguageId": {
            "type": "string",
            "description": "Id of the property's main language record in your system."
          },
          "availabilityState": {
            "type": "string",
            "description": "Availability state in your system, as supplied. Descriptive only: it does not mean the property is archived or deleted here.",
            "enum": [
              "ACTIVE",
              "PRIVATE",
              "REFERENCE",
              "RESERVED",
              "TAKEN",
              "SOLD",
              "ARCHIVED",
              "DELETED",
              "UNKNOWN"
            ]
          },
          "availabilityStartAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the property becomes available, as an ISO 8601 UTC instant."
          },
          "availabilityExpiresAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the property's availability ends, as an ISO 8601 UTC instant."
          },
          "propertyCategories": {
            "type": "array",
            "description": "Property categories, main category first (e.g. APARTMENT, LOFT, DETACHED_HOUSE, OFFICE, PARKING_SPACE).",
            "items": {
              "type": "string",
              "description": "Fine-grained category of a property. UNKNOWN is only ever read, never sent.",
              "enum": [
                "ADVERTISING_AREA",
                "AGRICULTURAL_LOT",
                "ALLOTMENT_GARDEN",
                "APARTMENT",
                "ARCADE",
                "ATELIER",
                "ATTIC_COMPARTMENT",
                "ATTIC_FLAT",
                "BAKERY",
                "BAR",
                "BOAT_DRY_DOCK",
                "BOAT_LANDING_STAGE",
                "BOAT_MOORING",
                "BUILDING_LOT",
                "BUTCHER",
                "CAFE",
                "CAMPGROUND",
                "CAR_PARK",
                "CAR_REPAIR_SHOP",
                "CARPENTRY_SHOP",
                "CASINO",
                "CASTLE",
                "CELLAR_COMPARTMENT",
                "CHALET",
                "CHEESE_FACTORY",
                "CLUB_DISCO",
                "COMMERCIAL_LOT",
                "COMMERCIAL_SPACE",
                "COVERED_MOTORBIKE_PARKING_SPACE",
                "COVERED_PARKING_SPACE",
                "DEPARTMENT_STORE",
                "DETACHED_HOUSE",
                "DISPLAY_WINDOW",
                "DOCTORS_OFFICE",
                "DOUBLE_GARAGE",
                "DUPLEX_HOUSE",
                "EARTH_SHELTERED_DWELLING",
                "FACTORY",
                "FARM_HOUSE",
                "FUEL_STATION",
                "FURNISHED_FLAT",
                "GOLF_COURSE",
                "GRANNY_FLAT",
                "HAIRDRESSER",
                "HOBBY_ROOM",
                "HOSPITAL",
                "HOTEL",
                "HORSE_BOX",
                "INDOOR_SWIMMING_POOL",
                "INDOOR_TENNIS_COURT",
                "INDUSTRIAL_LOT",
                "INDUSTRIAL_OBJECT",
                "KIOSK",
                "LABORATORY",
                "LIBRARY",
                "LOFT",
                "MAISONETTE",
                "MARKET_GARDEN",
                "MINI_GOLF_COURSE",
                "MOTEL",
                "MOVIE_THEATER",
                "MULTIPLEX_HOUSE",
                "MULTISTOREY_CAR_PARK",
                "NURSING_HOME",
                "OFFICE",
                "ONE_ROOM_FLAT",
                "OPEN_MOTORBIKE_PARKING_SPACE",
                "OPEN_PARKING_SPACE",
                "ORPHANAGE",
                "OUTDOOR_SWIMMING_POOL",
                "PARKING_SPACE",
                "PARTY_ROOM",
                "PLOT",
                "PUB",
                "RESIDENTIAL_COMMERCIAL_BUILDING",
                "RESTAURANT",
                "RETAIL_LOCATION",
                "RETIREMENT_HOME",
                "RIDING_HALL",
                "ROOF_FLAT",
                "ROW_HOUSE",
                "RUSTICO",
                "SANATORIUM",
                "SAUNA",
                "SHARED_APARTMENT",
                "SHOPPING_CENTER",
                "SINGLE_GARAGE",
                "SINGLE_ROOM",
                "SOLARIUM",
                "SPORTS_HALL",
                "SQUASH_BADMINTON",
                "STEPPED_FLAT",
                "STEPPED_HOUSE",
                "STOECKLI",
                "STORAGE_ROOM",
                "TENNIS_COURT",
                "UNDERGROUND_PARKING_SPACE",
                "VILLA",
                "WORKSHOP",
                "UNKNOWN"
              ]
            }
          },
          "hideAddress": {
            "type": "boolean",
            "description": "Whether the address should be hidden in public listings."
          },
          "locationDescription": {
            "type": "string",
            "description": "Free-text description of the location and surroundings."
          },
          "buildingZones": {
            "type": "string",
            "description": "Building / zoning designation of the plot.",
            "example": "W3"
          },
          "developmentState": {
            "type": "string",
            "description": "How far the plot is developed / serviced: FULL, PARTIAL or UNDEVELOPED.",
            "enum": [
              "FULL",
              "PARTIAL",
              "UNDEVELOPED",
              "UNKNOWN"
            ]
          },
          "cellarArea": {
            "type": "number",
            "description": "Cellar area in m²."
          },
          "balconyArea": {
            "type": "number",
            "description": "Balcony area in m²."
          },
          "terraceArea": {
            "type": "number",
            "description": "Terrace area in m²."
          },
          "loggiaArea": {
            "type": "number",
            "description": "Loggia area in m²."
          },
          "gardenArea": {
            "type": "number",
            "description": "Garden area in m²."
          },
          "ceilingHeight": {
            "type": "number",
            "description": "Ceiling height in metres."
          },
          "floorLoad": {
            "type": "number",
            "description": "Permissible floor load in kg/m²."
          },
          "elevatorLoad": {
            "type": "number",
            "description": "Elevator load capacity in kg."
          },
          "utilizationRatio": {
            "type": "number",
            "description": "Utilization ratio (floor area ratio) of the plot."
          },
          "utilizationRatioConstruction": {
            "type": "number",
            "description": "Construction utilization ratio of the plot."
          },
          "numberOfShowers": {
            "type": "integer",
            "format": "int32",
            "description": "Number of showers."
          },
          "numberOfToilets": {
            "type": "integer",
            "format": "int32",
            "description": "Number of toilets."
          },
          "numberOfGuestToilets": {
            "type": "integer",
            "format": "int32",
            "description": "Number of guest toilets."
          },
          "numberOfBalconies": {
            "type": "integer",
            "format": "int32",
            "description": "Number of balconies."
          },
          "numberOfParcels": {
            "type": "integer",
            "format": "int32",
            "description": "Number of land parcels."
          },
          "isYearBuiltUnknown": {
            "type": "boolean",
            "description": "Whether the build year is unknown."
          },
          "conditions": {
            "type": "array",
            "description": "Condition of the property, main condition first (e.g. NEW_BUILDING, FIRST_OCCUPANCY, LIKE_NEW, MODERNIZED, REFURBISHED, IN_NEED_OF_RENOVATION).",
            "items": {
              "type": "string",
              "description": "Structural condition of a property. UNKNOWN is only ever read, never sent.",
              "enum": [
                "NEW_BUILDING",
                "FIRST_OCCUPANCY",
                "LIKE_NEW",
                "OLD_BUILDING",
                "MODERNIZED",
                "REFURBISHED",
                "PARTIALLY_REFURBISHED",
                "IN_NEED_OF_RENOVATION",
                "PARTIALLY_IN_NEED_OF_RENOVATION",
                "GUTTED",
                "DILAPIDATED",
                "SHELL_CONSTRUCTION",
                "UNKNOWN"
              ]
            }
          },
          "hasBuildingPermission": {
            "type": "boolean",
            "description": "Whether a building permission exists."
          },
          "isShortTermConstructible": {
            "type": "boolean",
            "description": "Whether the plot can be built on at short notice."
          },
          "requiresPreliminaryEnquiry": {
            "type": "boolean",
            "description": "Whether a preliminary building enquiry is required."
          },
          "constructionMethod": {
            "type": "string",
            "description": "Construction method: SOLID or LIGHT.",
            "enum": [
              "SOLID",
              "LIGHT",
              "UNKNOWN"
            ]
          },
          "heatingType": {
            "type": "string",
            "description": "Heat generation: DISTRICT, ELECTRICITY, GAS, GEOTHERMAL_PROBE, HEATPUMP_AIR_AND_WATER, HEATPUMP, OIL, PHOTOVOLTAICS, SOLAR_THERMAL, WOOD_PELLET, WOOD or COAL.",
            "enum": [
              "DISTRICT",
              "ELECTRICITY",
              "GAS",
              "GEOTHERMAL_PROBE",
              "HEATPUMP_AIR_AND_WATER",
              "HEATPUMP",
              "OIL",
              "PHOTOVOLTAICS",
              "SOLAR_THERMAL",
              "WOOD_PELLET",
              "WOOD",
              "COAL",
              "UNKNOWN"
            ]
          },
          "heatingDistribution": {
            "type": "string",
            "description": "Heat distribution: RADIATOR or FLOOR.",
            "enum": [
              "RADIATOR",
              "FLOOR",
              "UNKNOWN"
            ]
          },
          "areHeatingCostsInServiceCharge": {
            "type": "boolean",
            "description": "Whether heating costs are included in the service charge."
          },
          "flooringTypes": {
            "type": "array",
            "description": "Flooring types present, as free-form values.",
            "items": {
              "type": "string"
            }
          },
          "pricePerSquareMeter": {
            "type": "number",
            "deprecated": true,
            "description": "Price per square metre. Deprecated: same stored value as `prices.buy.perSquareMeter`, which you should send instead."
          },
          "pricePerSquareMeterReferring": {
            "type": "string",
            "deprecated": true,
            "description": "What `pricePerSquareMeter` refers to: ALL, M2 or KM2. Deprecated: same stored value as `prices.buy.referring`.",
            "enum": [
              "ALL",
              "M2",
              "KM2",
              "UNKNOWN"
            ]
          },
          "netRentPrice": {
            "type": "number",
            "deprecated": true,
            "description": "Net rent. Deprecated: same stored value as `prices.rent.net`."
          },
          "grossRentPrice": {
            "type": "number",
            "deprecated": true,
            "description": "Gross rent. Deprecated: same stored value as `prices.rent.gross`."
          },
          "extraRentPrice": {
            "type": "number",
            "deprecated": true,
            "description": "Additional rent costs. Deprecated: same stored value as `prices.rent.extra`."
          },
          "heatingCosts": {
            "type": "number",
            "description": "Heating costs."
          },
          "maintenanceReserve": {
            "type": "number",
            "description": "Maintenance reserve contribution."
          },
          "actualRentalIncome": {
            "type": "number",
            "description": "Actual rental income."
          },
          "rentSubsidy": {
            "type": "number",
            "description": "Rent subsidy."
          },
          "priceDeposit": {
            "type": "number",
            "deprecated": true,
            "description": "Deposit. Deprecated: same stored value as `prices.deposit`."
          },
          "pricesRentInterval": {
            "type": "string",
            "deprecated": true,
            "description": "Billing interval of the rent: ONETIME, DAY, WEEK, MONTH or YEAR. Deprecated: same stored value as `prices.rent.interval`.",
            "enum": [
              "ONETIME",
              "DAY",
              "WEEK",
              "MONTH",
              "YEAR",
              "UNKNOWN"
            ]
          },
          "isPriceOnInquiry": {
            "type": "boolean",
            "description": "Whether the price is given on inquiry only."
          },
          "priceAuction": {
            "type": "boolean",
            "description": "Whether the property is sold by auction."
          },
          "commissionBuyerPercentage": {
            "type": "number",
            "description": "Buyer commission payable to the broker, in percent.",
            "example": "3.57"
          },
          "commissionSellerPercentage": {
            "type": "number",
            "description": "Seller commission payable to the broker, in percent.",
            "example": "3.57"
          },
          "pricesCommissionNote": {
            "type": "string",
            "description": "Free-text note about the commission."
          },
          "isCommissionFree": {
            "type": "boolean",
            "description": "Whether the property is commission-free."
          },
          "priceCommissionTotalAmount": {
            "type": "number",
            "description": "Total commission amount payable to the broker."
          },
          "pricesCommissionSellerTotal": {
            "type": "number",
            "description": "Total commission amount the seller pays the broker."
          },
          "pricesCommissionBuyerTotal": {
            "type": "number",
            "description": "Total commission amount the buyer pays the broker."
          },
          "prices": {
            "$ref": "#/components/schemas/PropertyPricesDTO",
            "description": "Prices under one shared currency. `buy.price` is the same stored value as `price`, and the other amounts are the same stored values as the deprecated flat price fields."
          },
          "rooms": {
            "type": "array",
            "description": "Per-room breakdown, each `{ roomType, count }` with `roomType` one of BEDROOM, KITCHEN, BATHROOM or LIVING_ROOM. Read-only: this API does not set it.",
            "items": {
              "$ref": "#/components/schemas/RoomDTO"
            }
          },
          "characteristics": {
            "$ref": "#/components/schemas/PropertyCharacteristicsDTO",
            "description": "Amenity and situation flags, most as APPLIES, DOES_NOT_APPLY or UNKNOWN, plus `numberOfGarages` and `numberOfCarPorts`."
          },
          "departmentIds": {
            "type": "array",
            "description": "Ids of the departments handling the property in your system.",
            "items": {
              "type": "string"
            }
          },
          "publishers": {
            "type": "array",
            "description": "Portal / publisher configurations, each `{ id, options: [{ key, value }], promotions }`.",
            "items": {
              "$ref": "#/components/schemas/PublisherDTO"
            }
          },
          "isPublished": {
            "type": "boolean",
            "description": "Whether the property is published in your system."
          },
          "hasPriceReduction": {
            "type": "boolean",
            "description": "Whether the property has a price reduction."
          },
          "isNewListing": {
            "type": "boolean",
            "description": "Whether the property is a new listing."
          },
          "showGoogleMap": {
            "type": "boolean",
            "description": "Whether a map should be shown with the listing."
          },
          "swissReferences": {
            "$ref": "#/components/schemas/SwissReferencesDTO",
            "description": "Swiss register references: `egid`, `ewid`, `egrid` and `minergieCertification` (e.g. MINERGIE, MINERGIE_P, MINERGIE_A_ECO)."
          },
          "parcelNumbers": {
            "type": "array",
            "description": "Land-register parcel numbers.",
            "items": {
              "type": "string"
            }
          },
          "parkingLots": {
            "type": "array",
            "description": "Parking offered with the property, each `{ type, count, price, listingType }`; `type` is free-form (e.g. GARAGE).",
            "items": {
              "$ref": "#/components/schemas/ParkingLotDTO"
            }
          },
          "mobileUrl": {
            "type": "string",
            "description": "URL of the mobile-optimised listing."
          },
          "rentableArea": {
            "type": "number",
            "description": "Rentable area in m²."
          },
          "buildingVolume": {
            "type": "number",
            "description": "Building volume in m³."
          },
          "hallHeight": {
            "type": "number",
            "description": "Hall height in metres, for commercial halls. Distinct from `ceilingHeight`."
          },
          "craneCapacity": {
            "type": "number",
            "description": "Crane capacity in tonnes."
          },
          "balconyTerraceArea": {
            "type": "number",
            "description": "Combined balcony and terrace area in m², as some CRMs report it. Independent of `balconyArea` and `terraceArea`."
          },
          "requiresCertificateOfEligibility": {
            "type": "boolean",
            "description": "Whether a certificate of eligibility (Wohnberechtigungsschein) is required."
          },
          "isExclusive": {
            "type": "boolean",
            "description": "Whether the property is marketed exclusively."
          },
          "virtualTourLinks": {
            "type": "array",
            "description": "Virtual tour links; entries that were not valid http(s) URLs were dropped.",
            "items": {
              "type": "string"
            }
          },
          "videoLinks": {
            "type": "array",
            "description": "Video links; entries that were not valid http(s) URLs were dropped.",
            "items": {
              "type": "string"
            }
          },
          "customFields": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Your own custom fields, returned exactly as supplied."
          }
        }
      },
      "RoomDTO": {
        "type": "object",
        "properties": {
          "roomType": {
            "type": "string",
            "description": "The type of the room.",
            "enum": [
              "BEDROOM",
              "KITCHEN",
              "BATHROOM",
              "LIVING_ROOM",
              "UNKNOWN"
            ]
          },
          "count": {
            "type": "number",
            "description": "The count of the room type."
          }
        },
        "required": [
          "count",
          "roomType"
        ]
      },
      "VisualsReadyEvent": {
        "type": "object",
        "required": [
          "event",
          "timestamp",
          "orderId",
          "assignmentId",
          "visualType",
          "product"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "VISUALS_READY"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "When the webhook was sent.",
            "example": "2023-01-15T12:45:00Z"
          },
          "orderId": {
            "type": "string",
            "example": "100234"
          },
          "assignmentId": {
            "type": "string",
            "example": "a1b2c3d4"
          },
          "visualType": {
            "type": "string",
            "description": "Resource type that is ready. Mirrors the platform resource taxonomy.",
            "example": "POST"
          },
          "product": {
            "type": "string",
            "description": "Product/deliverable that is ready. Mirrors the platform product taxonomy.",
            "example": "GROUND_PHOTO"
          },
          "realEstatePropertyId": {
            "type": "string",
            "format": "uuid",
            "description": "Real estate property id, if applicable."
          },
          "objectReferenceId": {
            "type": "string",
            "description": "Client-supplied object reference, if provided."
          }
        }
      },
      "PhotographerBookedEvent": {
        "type": "object",
        "required": [
          "event",
          "timestamp",
          "orderId",
          "photographerId"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "PHOTOGRAPHER_BOOKED"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "example": "2023-01-15T12:45:00Z"
          },
          "orderId": {
            "type": "string",
            "example": "100234"
          },
          "photographerId": {
            "type": "string",
            "description": "Public id of the photographer (creative) who accepted.",
            "example": "55021"
          },
          "assignmentId": {
            "type": "string",
            "description": "Assignment id, when available.",
            "example": "a1b2c3d4"
          }
        }
      },
      "OrderStatusUpdatedEvent": {
        "type": "object",
        "required": [
          "event",
          "occurredAt",
          "orderId",
          "previousStatus",
          "newStatus"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "ORDER_STATUS_UPDATED"
          },
          "occurredAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the change occurred on the platform.",
            "example": "2026-06-25T09:30:00Z"
          },
          "orderId": {
            "type": "string",
            "example": "100234"
          },
          "previousStatus": {
            "type": "string",
            "example": "PLACED"
          },
          "newStatus": {
            "type": "string",
            "example": "IN_PROGRESS"
          }
        }
      },
      "AssignmentStatusUpdatedEvent": {
        "type": "object",
        "required": [
          "event",
          "occurredAt",
          "orderId",
          "assignmentId",
          "previousStatus",
          "newStatus"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "ASSIGNMENT_STATUS_UPDATED"
          },
          "occurredAt": {
            "type": "string",
            "format": "date-time",
            "example": "2026-06-25T09:30:00Z"
          },
          "orderId": {
            "type": "string",
            "example": "100234"
          },
          "assignmentId": {
            "type": "string",
            "example": "a1b2c3d4"
          },
          "previousStatus": {
            "type": "string",
            "example": "SCHEDULED"
          },
          "newStatus": {
            "type": "string",
            "example": "IN_PRODUCTION"
          },
          "assignmentType": {
            "type": "string",
            "description": "Assignment type, when available."
          },
          "scheduledAt": {
            "type": "string",
            "format": "date-time",
            "description": "Confirmed shooting start, when available."
          },
          "estimatedDeliveryAt": {
            "type": "string",
            "format": "date",
            "description": "Estimated delivery date (date-only), when available."
          },
          "actionRequired": {
            "type": "string",
            "description": "Action-required detail, when applicable."
          }
        }
      },
      "AppointmentDateUpdatedEvent": {
        "type": "object",
        "required": [
          "event",
          "occurredAt",
          "orderId",
          "assignmentId",
          "scheduledAt"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "APPOINTMENT_DATE_UPDATED"
          },
          "occurredAt": {
            "type": "string",
            "format": "date-time",
            "example": "2026-06-25T09:30:00Z"
          },
          "orderId": {
            "type": "string",
            "example": "100234"
          },
          "assignmentId": {
            "type": "string",
            "example": "a1b2c3d4"
          },
          "assignmentType": {
            "type": "string",
            "description": "Assignment type, when available."
          },
          "scheduledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "New confirmed shooting start. Always present; `null` means the appointment was cleared (reschedule pending).\n"
          }
        }
      },
      "EstimatedDeliveryUpdatedEvent": {
        "type": "object",
        "required": [
          "event",
          "occurredAt",
          "orderId",
          "assignmentId",
          "estimatedDeliveryAt"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "ESTIMATED_DELIVERY_UPDATED"
          },
          "occurredAt": {
            "type": "string",
            "format": "date-time",
            "example": "2026-06-25T09:30:00Z"
          },
          "orderId": {
            "type": "string",
            "example": "100234"
          },
          "assignmentId": {
            "type": "string",
            "example": "a1b2c3d4"
          },
          "assignmentType": {
            "type": "string",
            "description": "Assignment type, when available."
          },
          "estimatedDeliveryAt": {
            "type": "string",
            "format": "date",
            "description": "Estimated delivery date (date-only).",
            "example": "2026-07-02"
          }
        }
      },
      "MarketingMaterialsReadyEvent": {
        "type": "object",
        "required": [
          "event",
          "timestamp",
          "propertyId",
          "targetPlatform"
        ],
        "properties": {
          "event": {
            "type": "string",
            "const": "MARKETING_MATERIALS_READY"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "example": "2023-01-15T12:45:00Z"
          },
          "propertyId": {
            "type": "string",
            "format": "uuid",
            "description": "Real estate property id."
          },
          "targetPlatform": {
            "type": "string",
            "description": "Target platform the materials were prepared for."
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "description": "JWT Authentication. Enter your token in the format: Bearer {token}",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "parameters": {
      "EventTypeHeader": {
        "name": "X-Event-Type",
        "in": "header",
        "required": true,
        "description": "The event name. Matches the `event` field in the body.",
        "schema": {
          "type": "string",
          "example": "ASSIGNMENT_STATUS_UPDATED"
        }
      }
    }
  },
  "webhooks": {
    "visualsReady": {
      "post": {
        "summary": "Visuals ready",
        "description": "Sent when materials (visuals, documents, or other deliverables) are ready for download. On receipt, call the Materials API to retrieve the actual files.\n",
        "operationId": "onVisualsReady",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VisualsReadyEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    },
    "photographerBooked": {
      "post": {
        "summary": "Photographer booked",
        "description": "Sent when a photographer (creative) has accepted an assignment.",
        "operationId": "onPhotographerBooked",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PhotographerBookedEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    },
    "orderStatusUpdated": {
      "post": {
        "summary": "Order status updated",
        "description": "Sent when an order transitions between statuses.",
        "operationId": "onOrderStatusUpdated",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderStatusUpdatedEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    },
    "assignmentStatusUpdated": {
      "post": {
        "summary": "Assignment status updated",
        "description": "Sent when an assignment transitions between statuses. May also be sent as a same-status nudge carrying refreshed logistics fields.\n",
        "operationId": "onAssignmentStatusUpdated",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssignmentStatusUpdatedEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    },
    "appointmentDateUpdated": {
      "post": {
        "summary": "Appointment date updated",
        "description": "Sent when an assignment's shooting appointment date changes. `scheduledAt` is always present and is `null` when the appointment was cleared (reschedule pending).\n",
        "operationId": "onAppointmentDateUpdated",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppointmentDateUpdatedEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    },
    "estimatedDeliveryUpdated": {
      "post": {
        "summary": "Estimated delivery updated",
        "description": "Sent when an assignment's estimated delivery date changes.",
        "operationId": "onEstimatedDeliveryUpdated",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EstimatedDeliveryUpdatedEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    },
    "marketingMaterialsReady": {
      "post": {
        "summary": "Marketing materials ready",
        "description": "Sent when marketing materials for a property are ready for a target platform.",
        "operationId": "onMarketingMaterialsReady",
        "parameters": [
          {
            "$ref": "#/components/parameters/EventTypeHeader"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MarketingMaterialsReadyEvent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged by the consumer."
          }
        },
        "tags": [
          "Webhook Events"
        ]
      }
    }
  }
}
```