MatchOffice

Search for available commercial real estate locations

{
  "type": "object",
  "properties": {
    "country_alpha2": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code (lowercase). Always infer from the city or country name — 'Kyiv' or 'Ukraine' → 'ua', 'Stockholm' or 'Sweden' → 'se', 'Berlin' or 'Germany' → 'de', 'Paris' or 'France' → 'fr'. Uppercase is accepted and normalized. Use 'global' ONLY for country-agnostic searches with no location query (e.g. browsing all available countries). Never combine 'global' with a query — geo resolution requires a country."
    },
    "query": {
      "type": "string",
      "description": "City, district, neighborhood, or street name — resolved via autocomplete search. Examples: 'Copenhagen', 'København', 'Østerbro', 'Vesterbro', 'Nørrebro'."
    },
    "section": {
      "type": "string",
      "enum": [
        "lease",
        "sale"
      ],
      "description": "Property section. 'lease' (default) for rentals; 'sale' for properties for sale."
    },
    "kinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "office",
          "business_center",
          "warehouse",
          "store",
          "coworking",
          "meeting_room",
          "virtual_office",
          "parking",
          "housing",
          "lot"
        ]
      },
      "description": "Property type filter (OR logic). Matches locations where the primary kind OR any secondary kind is in the list — a business_center with secondary_kind 'office' will appear for kinds: ['office']. Lease kinds: office, business_center, warehouse, store, coworking, meeting_room, virtual_office, parking. Sale kinds: housing, office, warehouse, store, lot."
    },
    "area_min": {
      "type": "integer",
      "description": "Minimum area in m² (inclusive). Uses overlap semantics: a location is included if its available range overlaps [area_min, area_max], e.g. a listing offering 50–500 m² will appear for area_min: 400."
    },
    "area_max": {
      "type": "integer",
      "description": "Maximum area in m² (inclusive). Must be greater than or equal to area_min when both are provided."
    },
    "rent_min": {
      "type": "integer",
      "description": "Minimum rent (see rent_format and currency)."
    },
    "rent_max": {
      "type": "integer",
      "description": "Maximum rent (see rent_format and currency)."
    },
    "currency": {
      "type": "string",
      "description": "Currency for rent_min/rent_max values, e.g. EUR, DKK, SEK. Defaults to country's native currency."
    },
    "rent_format": {
      "type": "string",
      "enum": [
        "monthly",
        "yearly"
      ],
      "description": "Lease only. 'monthly' (default) = total rent per month; 'yearly' = rent per m²/year."
    },
    "facilities": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "24_hour",
          "24h",
          "access_24_hour",
          "accessibility",
          "air_conditioning",
          "alarm_system",
          "atm",
          "auditorium",
          "balcony",
          "bathroom",
          "bike_racks",
          "canteen",
          "catering",
          "cctv",
          "cleaning",
          "closed_circuit_television",
          "conference_rooms",
          "cooling",
          "copying_facilities",
          "coworking",
          "coworking_space",
          "disabled",
          "electric_car_charge",
          "elevator",
          "enclosed_property",
          "ev_charger",
          "ev_charging",
          "fiber_internet",
          "furnished",
          "gym",
          "hot_desk",
          "internet",
          "it_support",
          "kitchenette",
          "lounge",
          "meeting_rooms",
          "moving",
          "moving_service",
          "on_site_restaurant",
          "outdoor_area",
          "own_signage",
          "parking",
          "pet_friendly",
          "phone_answering",
          "postal_facilities",
          "private_offices",
          "reception",
          "restroom",
          "sauna",
          "secretarial",
          "shower",
          "spatial_planning",
          "storage",
          "telephone_system",
          "toilets",
          "unfurnished",
          "video_conference",
          "virtual_offices",
          "wc",
          "wheelchair",
          "wheelchair_accessible",
          "wifi"
        ]
      },
      "description": "Facility keys to filter by (OR logic). Common aliases accepted: cctv, wheelchair, 24h, ev_charging, internet, moving."
    },
    "suitable_for": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "cafe",
          "showroom",
          "clinic",
          "education",
          "popup_store",
          "hair_salon",
          "high_ceiling_storage",
          "storage_hotel",
          "production",
          "workshop"
        ]
      },
      "description": "Tenant type suitability filter."
    },
    "energy_rating": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "A2020",
          "A2015",
          "A2010",
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "Exempted"
        ]
      },
      "description": "Energy rating filter."
    },
    "sort_by": {
      "type": "string",
      "description": "Sort order in 'column|direction' format. E.g. 'yearly_rent_per_m2_amount_from|asc', 'area_from|asc', 'created_at|desc'."
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "description": "Page number starting at 1. Returns 20 results per page. Use ceil(total / 20) to calculate total pages."
    }
  },
  "required": [
    "country_alpha2"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Get full details for a single location by ID

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Location ID"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Submit an inquiry for a location

{
  "type": "object",
  "properties": {
    "location_id": {
      "type": "integer",
      "description": "Location ID to inquire about"
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "description": "Full name of the inquirer (max 200 chars)"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Valid email address"
    },
    "phone": {
      "type": "string",
      "minLength": 6,
      "description": "Phone number (min 6 chars)"
    },
    "company": {
      "type": "string",
      "maxLength": 200,
      "description": "Company name (optional, max 200 chars)"
    },
    "comment": {
      "type": "string",
      "maxLength": 2000,
      "description": "Message to the provider (optional, max 2000 chars)"
    }
  },
  "required": [
    "location_id",
    "name",
    "email",
    "phone"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}