Objekte

Objekte lesen

GET https://api.propstack.de/v1/units?with_meta=1

Query Parameters

NameTypeDescription

order

string

Aufsteigend oder absteigend sortieren. Entweder asc oder desc

sort_by

string

Feld wonach sortiert werden soll. Siehe unten für mögliche Optionen (Default ist unit_id.raw)

status

string

ID des Statuses, in welchem sich das Objekt befinden muss. Mehrere Stati übergibt man kommagetrennt

group

integer

Merkmal-ID, die das Objekt haben muss. Kommagetrennt, wenn es eines von mehreren Merkmalen haben muss

q

string

Volltextsuche: Sucht in unit_id, street, zip_code, city, Bezirk, exposee_id

country

string

2-stelliger ISO Code des Landes, zB DE oder FR

project_id

integer

nur zu einem bestimmten Projekt die Einheiten

marketing_type

string

ob Kauf (BUY) oder Miete (RENT)

rs_type

string

siehe unten für mögliche Werte (z.B. HOUSE, um nur Häuser zu erhalten)

expand

number

kann jeglichen Wert haben. Wenn Parameter mitgegeben wird, sieht das Objekt zu einem Objekt genau so aus wie wenn man ein einzelnes Objekt aufrufen würde.

archived

string

wenn -1, dann werden alle Objekte gezogen, bei 1, nur die archivierten. Ansonsten standardmäßig erhält man nur die Nicht-Archivierten

property_ids

array

Array aus IDs, um nur die Objekte mit bestimmten Propstack-IDs aufzurufen

{
    "data": [
        {
            "id": 5,
            "name": "001",
            "title": "Traumhafte Familienwohnung im klassischen Altbau in ruhiger Lage!",
            "unit_id": "001",
            "exposee_id": "",
            "project_id": 2,
            "street": "Gottschalkstraße",
            "house_number": "7",
            "district": null,
            "region": "Berlin",
            "zip_code": "13359",
            "city": "Berlin",
            "country": "DEU",
            "address": "Gottschalkstraße 7, 13359 Berlin, Deutschland",
            "short_address": "Gottschalkstraße 7, 13359 Berlin",
            "lat": null,
            "lng": null,
            "number_of_rooms": 3,
            "price": null,
            "base_rent": 400,
            "living_space": 77,
            "number_of_bed_rooms": 2,
            "number_of_bath_rooms": 2,
            "property_space_value": 77,
            "images": [
                {
                    "original": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/Objekt.jpg",
                    "big": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/big_Objekt.jpg",
                    "medium": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/medium_Objekt.jpg",
                    "thumb": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/thumb_Objekt.jpg",
                    "tags": null,
                    "is_floorplan": false,
                    "is_private": false
                }
            ],
            "status": {
                "id": 2,
                "name": "In Vorbereitung",
                "color": "#ed892b"
            }
        },
    ],
    "meta": {
        "total_count": 150
    }
}

Eine Excel-Datei mit allen relevanten Felder eines Objektes, gruppiert nach Objekttyp:

Mehrsprachigkeit

In Propstack kann man bestimmte Texte eines Objektes in mehreren Sprachen einstellen. Folgende Felder können übersetzt werden:

  1. Überschrift (title)

  2. Objektbeschreibung (description_note)

  3. Lagebeschreibung (location_note)

  4. Ausstattung (furnishing_note)

  5. Sonstiges (other_note)

  6. Käuferprovision (courtage)

  7. Provisionshinweis (courtage_note)

Um die Objekte in einer anderen Sprache zu erhalten gibt man einen weiteren Parameter locale mit. Standardmäßig erhält man die deutsche Sprache. Über locale=en würde man die englischen Texte erhalten. Es ist auch möglich, mehrere Sprachen zu erhalten. Beispiel: locale=de,en

Weitere Filtermöglichkeiten

Folgende Felder kann man zusätzlich über die API filtern anhand von "ab-bis" Angaben:

  • Kaufpreis: price

  • Kaltmiete: base_rent

  • Warmmiete: total_rent

  • Fläche: property_space_value

  • Wohnfläche: living_space

  • Grundstücksfläche: plot_area

  • Zimmer: number_of_rooms

  • Schlafzimmer: number_of_bed_rooms

  • Badezimmer: number_of_bath_rooms

  • Etage: floor

  • Baujahr: construction_year

Die Parameter dafür haben immer ein _from oder _to angehängt, um zu bestimmen ob es ab diesem Wert gilt oder bis zu diesem Wert. Beispiel:

?price_from=300000&price_to=350000 wirft alle Objekte aus, deren Preis zwischen 300.000 und 350.000 € liegen. ?plot_area=1500 wirft alle Objekte aus, deren Grundstücksfläche über 1.500qm beträgt.

Sortierungsmöglichkeiten

  • Auftragsnummer: exposee_id

  • Baujahr: construction_year

  • Einheitenummer: unit_id.raw

  • Etage: floor

  • Erstellungsdatum: created_at

  • Fläche: property_space_value

  • Grundstücksfläche: plot_area

  • Kaltmiete: base_rent

  • Kaufpreis: price

  • Preis: object_price

  • Fläche/qm: price_per_sqm

  • Status: property_status_position

  • Straße: street_number.raw

  • Verkaufsdatum: sold_date

  • Warmmiete: total_rent

  • Zimmer: number_of_rooms

  • Zuletzt bearbeitet: updated_at

Mögliche Vermarktungsart (marketing_type):

  1. BUY

  2. RENT

Mögliche Oberkategorie für Objekttypen object_type:

  1. LIVING

  2. COMMERCIAL

  3. INVESTMENT

Mögliche Objekttypen (rs_type):

  1. APARTMENT

  2. HOUSE

  3. TRADE_SITE

  4. GARAGE

  5. SHORT_TERM_ACCOMODATION

  6. OFFICE

  7. GASTRONOMY

  8. INDUSTRY

  9. STORE

  10. SPECIAL_PURPOSE

  11. INVESTMENT

(Text-)Felder, die in verschiedenen Sprachen hinterlegt werden können:

  • title

  • description_note

  • location_note

  • furnishing_note

  • other_note

  • long_description_note

  • long_location_note

  • long_furnishing_note

  • long_other_note

  • courtage

  • courtage_note

Mögliche Objektarten (rs_category):

  • ROOF_STOREY - Dachgeschoss

  • LOFT - Loft

  • MAISONETTE - Maisonette

  • PENTHOUSE - Penthouse

  • TERRACED_FLAT - Terrassenwohnung

  • GROUND_FLOOR - Erdgeschosswohnung

  • APARTMENT - Etagenwohnung

  • RAISED_GROUND_FLOOR - Hochparterre

  • HALF_BASEMENT - Souterrain

  • OTHER - Sonstige

  • SINGLE_FAMILY_HOUSE - Einfamilienhaus

  • TWO_FAMILY_HOUSE - Zweifamilienhaus

  • TERRACE_HOUSE - Reihenhaus

  • MID_TERRACE_HOUSE - Reihenmittelhaus

  • TERRACE_END_HOUSE - Reihenendhaus

  • END_TERRACE_HOUSE - Reiheneckhaus

  • MULTI_FAMILY_HOUSE - Mehrfamilienhaus

  • TOWNHOUSE - Stadthaus

  • FINCA - Finca

  • FREEHOLD_FLAT - Eigentumswohnung

  • BUNGALOW - Bungalow

  • FARMHOUSE - Bauernhaus

  • SEMIDETACHED_HOUSE - Doppelhaushälfte

  • VILLA - Villa

  • CASTLE_MANOR_HOUSE - Burg/Schloss

  • SPECIAL_REAL_ESTATE - Besondere Immobilie

  • TWIN_SINGLE_FAMILY_HOUSE - Doppeleinfamilienhaus

  • GARAGE - Garage

  • STREET_PARKING - Außenstellplatz

  • CARPORT - Carport

  • DUPLEX - Duplex

  • CAR_PARK - Parkhaus

  • UNDERGROUND_GARAGE - Tiefgarage

  • DOUBLE_GARAGE - Doppelgarage

  • NO_INFORMATION - Keine Angabe

  • STUDIO - Atelier

  • OFFICE - Büro

  • OFFICE_FLOOR - Büroetage

  • OFFICE_BUILDING - Bürohaus

  • OFFICE_CENTRE - Bürozentrum

  • OFFICE_STORAGE_BUILDING - Büro-/ Lagergebäude

  • SURGERY - Praxis

  • SURGERY_FLOOR - Praxisetage

  • SURGERY_BUILDING - Praxishaus

  • COMMERCIAL_CENTRE - Gewerbezentrum

  • LIVING_AND_COMMERCIAL_BUILDING - Wohn- und Geschäftsgebäude

  • OFFICE_AND_COMMERCIAL_BUILDING - Büro- und Geschäftsgebäude

  • BAR_LOUNGE - Barbetrieb/Lounge

  • CAFE - Café

  • CLUB_DISCO - Club/Diskothek

  • GUESTS_HOUSE - Gästehaus

  • TAVERN - Gaststätte

  • HOTEL - Hotel

  • HOTEL_RESIDENCE - Hotelanwesen

  • HOTEL_GARNI - Hotel garni

  • PENSION - Pension

  • RESTAURANT - Restaurant

  • SHOWROOM_SPACE - Ausstellungsfläche

  • SHOPPING_CENTRE - Einkaufszentrum

  • FACTORY_OUTLET - Factory Outlet

  • DEPARTMENT_STORE - Kaufhaus

  • KIOSK - Kiosk

  • STORE - Laden

  • SELF_SERVICE_MARKET - SB-Markt

  • SALES_AREA - Verkaufsfläche

  • SALES_HALL - Verkaufshalle

  • RESIDENCE - Anwesen

  • FARM - Bauernhof

  • HORSE_FARM - Reiterhof

  • VINEYARD - Weingut

  • REPAIR_SHOP - Werkstatt

  • LEISURE_FACILITY - Freizeitanlage

  • INDUSTRIAL_AREA - Gewerbefläche

  • SPECIAL_ESTATE - Spezialobjekt

  • LIVING_BUSINESS_HOUSE - Wohn- und Geschäftshaus

  • HOUSING_ESTATE - Wohnanlage

  • MICRO_APARTMENTS - Micro-Apartments

  • COMMERCIAL_BUILDING - Geschäftshaus

  • SHOP_SALES_FLOOR - Laden/Verkaufsfläche

  • SUPERMARKET - Supermarkt

  • RETAIL_PARK - Fachmarktzentrum

  • BOARDING_HOUSE - Boarding House

  • CLINIC - Klinik

  • ASSISTED_LIVING - Betreutes Wohnen

  • HALL_STORAGE - Halle/Logistik

  • INDUSTRIAL_PROPERTY - Produktion/Fertigung

Objekt anlegen

POST https://api.propstack.de/v1/units

Path Parameters

NameTypeDescription

property

object

siehe alle möglichen Werte für ein Objekt

Objekt anlegen mit Eigentümer

Beim Anlegen eines Objektes kann auch gleichzeitig ein Eigentümer mitverknüpft werden. Der Payload dafür sieht wie folgt aus:

{
  "property": {
    "title": "Nice apartment",
    // ...
    "relationships_attributes": [{
        "internal_name": "owner",
        "related_client_id": 123
    }]
  }
}

Der Eigentümer muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter related_client_id mitgegeben.

Objekt anlegen mit einem verknüpften Kontakt

Beim Anlegen eines Objektes kann auch gleichzeitig ein Kontakt (Partner) mitverknüpft werden. Der Payload dafür sieht wie folgt aus:

{
  "property": {
    "title": "Nice apartment",
    // ...
    "relationships_attributes": [{
        "internal_name": "partner",
        "name": "Käufer",
        "related_client_id": 123
    }]
  }
}

Der Kontakt muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter related_client_id mitgegeben.

Objekt bearbeiten

PUT https://api.propstack.de/v1/units/:id

Ein vorhandendes Objekt bearbeiten

Request Body

NameTypeDescription

property

object

siehe alle möglichen Werte für ein Objekt

Objekt löschen

DELETE https://api.propstack.de/v1/units/:id

Ein vorhandenes Objekt löschen

Objekt lesen

GET https://api.propstack.de/v1/units/:id?new=1

{
    "id": 5,
    "name": "001",
    "title": {
        "label": "Überschrift",
        "value": "Traumhafte Familienwohnung im klassischen Altbau in ruhiger Lage!"
    },
    "unit_id": "001",
    "exposee_id": "",
    "project_id": 2,
    "broker_id": 1,
    "archived": false,
    "street": "Gottschalkstraße",
    "house_number": "7",
    "zip_code": "13359",
    "city": "Berlin",
    "address": "Gottschalkstraße 7, 13359 Berlin, Deutschland",
    "short_address": "Gottschalkstraße 7, 13359 Berlin",
    "lat": null,
    "lng": null,
    "country": "DEU",
    "district": {
        "label": "Gemarkung",
        "value": null
    },
    "region": "Berlin",
    "hide_address": true,
    "location_name": null,
    "sublocality_level_1": null,
    "property_space_value": 77,
    "for_bidding": false,
    "marketing_type": "RENT",
    "object_type": "LIVING",
    "rs_type": "APARTMENT",
    "rs_category": "PENTHOUSE",
    "custom_fields": {
        "gebaudeversicherung": {
            "value": null,
            "pretty_value": null
        }
    },
    "sold_date": null,
    "valuation_price_from": null,
    "valuation_price_to": null,
    "created_at_formatted": "04.06.2019 17:09",
    "created_at": "2019-06-04T17:09:21.109+02:00",
    "updated_at_formatted": "08.10.2019 14:16",
    "updated_at": "2019-10-08T14:16:29.488+02:00",
    "description_note": {
        "label": "Beschreibung",
        "value": "Die bezugsfreie Eigentumswohnung befindet sich im Hochparterre und EG in einem gepflegten Jugendstilgebäude. The dwelling is located in the 1. floor in a building of 1908."
    },
    "location_note": {
        "label": "Lage",
        "value": "In Berlin Schöneberg nahe dem S-Bhf. \"Friedenau\" (S1) befindet sich dieser repräsentative Altbau mit der hier angebotenen Wohnung. \r\n Wir können Ihre Anfrage am schnellsten bearbeiten, wenn Sie uns direkt aus der Insertion (Anzeige) heraus eine Anfrage SCHRIFTLICH senden. Bitte hierzu Ihren Namen, Adresse u. Telefonnumer eintragen. Wir senden Ihnen dann gern und sofort ein Exposé. Bitte verzichten Sie im Vorfeld auf telefonische Auskünfte, Anfragen. Wir danken für Ihr Verständnis."
    },
    "furnishing_note": {
        "label": "Ausstattung",
        "value": "Groß Terrasse nach Westen, sowie sehr große Terrasse auf dem Dach. Fußböden mit Eiche-Parkett im Fischgräte-Muster. Gas-Zentralheizung mit Warmwasser-Versorgung. Elektrisch zu öffnende Oberlichter, neue Elektro-Installation, teilweise mit 4 Steckdosen in jeder Ecke.Alle Anschlüsse für Bäder und Küche vorhanden. Küche und Bäder müssen vom Käufer selber eingebaut werden und gehören nicht zum Lieferumfang.Im Übrigen Gewährleistung 5 Jahre gemäß BGB."
    },
    "other_note": {
        "label": "Sonstiges",
        "value": ""
    },
    "long_description_note": {
        "label": "Objektbeschreibung (lang)",
        "value": ""
    },
    "long_location_note": {
        "label": "Lage (lang)",
        "value": ""
    },
    "long_furnishing_note": {
        "label": "Ausstattung (lang)",
        "value": ""
    },
    "long_other_note": {
        "label": "Sonstiges (lang)",
        "value": ""
    },
    "courtage": {
        "label": "Provision",
        "value": ""
    },
    "courtage_note": {
        "label": "Provisionshinweis",
        "value": ""
    },
    "number_of_rooms": {
        "label": "Zimmer",
        "value": 3
    },
    "price": {
        "label": "Kaufpreis",
        "value": null
    },
    "base_rent": {
        "label": "Kaltmiete",
        "value": 400
    },
    "living_space": {
        "label": "Wohnfläche ca.",
        "value": 77
    },
    "start_rental_date": {
        "label": "Bezugsfrei ab",
        "value": null
    },
    "commercialization_type": {
        "label": "Vermarktungsart",
        "value": null
    },
    "price_type": {
        "label": "Preistyp",
        "value": null
    },
    "floor": {
        "label": "Etage",
        "value": "5"
    },
    "number_of_floors": {
        "label": "Etagenzahl",
        "value": 5
    },
    "energy_certificate_start_date": {
        "label": "Energieausweis: Ausstellungsdatum",
        "value": null
    },
    "energy_certificate_end_date": {
        "label": "Energieausweis: gültig bis",
        "value": null
    },
    "energy_efficiency_class": {
        "label": "Energieeffizienzklasse",
        "value": "NO_INFORMATION"
    },
    "thermal_characteristic": {
        "label": "Endenergiebedarf",
        "value": null
    },
    "deposit": {
        "label": "Kaution",
        "value": ""
    },
    "rent_duration": {
        "label": "Mietdauer",
        "value": null
    },
    "lan_cables": {
        "label": "LAN-Kabel",
        "value": null
    },
    "air_conditioning": {
        "label": "Klimaanlage",
        "value": false
    },
    "duration": {
        "label": "Laufzeit",
        "value": null
    },
    "duration_until": {
        "label": "Auftragsende",
        "value": null
    },
    "has_furniture": {
        "label": "Möblierung",
        "value": null
    },
    "floor_position": {
        "label": "Etagenlage",
        "value": "links"
    },
    "plot_number": {
        "label": "Flurstück",
        "value": null
    },
    "renter": {
        "label": "Aktueller Mieter",
        "value": null
    },
    "note": {
        "label": "Notiz",
        "value": null
    },
    "te_id": {
        "label": "Teilungserklärungs-Nr.",
        "value": null
    },
    "crane_runway_load": {
        "label": "Kranbahn Traglast in Tonnen",
        "value": null
    },
    "floor_load": {
        "label": "Bodenbelastung in kg/m²",
        "value": null
    },
    "connected_load": {
        "label": "Stromanschlusswert (kVA)",
        "value": false
    },
    "shop_window_length": {
        "label": "Schaufensterfront",
        "value": null
    },
    "price_per_sqm": {
        "label": "Preis/m²",
        "value": 5.19
    },
    "price_multiplier": {
        "label": "Faktor-Ist",
        "value": null
    },
    "industrial_area": {
        "label": "Gewerbefläche",
        "value": null
    },
    "rental_income_target": {
        "label": "Nettomiete Soll p.a.",
        "value": null
    },
    "rental_income_actual": {
        "label": "Nettomiete Ist p.a.",
        "value": null
    },
    "sold_price": {
        "label": "Realisierter Preis",
        "value": null
    },
    "min_divisible": {
        "label": "Teilbar ab",
        "value": null
    },
    "grz": {
        "label": "GRZ",
        "value": null
    },
    "gfz": {
        "label": "GFZ",
        "value": null
    },
    "length_garage": {
        "label": "Länge der Garage",
        "value": null
    },
    "width_garage": {
        "label": "Breite der Garage",
        "value": null
    },
    "height_garage": {
        "label": "Höhe der Garage",
        "value": null
    },
    "hall_height": {
        "label": "Hallen-/ Geschosshöhe",
        "value": null
    },
    "goods_lift_load": {
        "label": "Tragkraft Lastenaufzug in kg",
        "value": null
    },
    "cost_other": {
        "label": "Kostenanteil sonstiges",
        "value": null
    },
    "cost_lift": {
        "label": "Kostenanteil Aufzug Gartenhaus",
        "value": null
    },
    "cost_balcony": {
        "label": "Kostenanteil Balkone",
        "value": null
    },
    "min_rental_time": {
        "label": "Mindestmietdauer",
        "value": null
    },
    "max_rental_time": {
        "label": "Maximale Mietdauer",
        "value": null
    },
    "co_ownership_share": {
        "label": "Miteigentumsanteil",
        "value": null
    },
    "rental_income": {
        "label": "Mieteinnahmen/Monat",
        "value": null
    },
    "total_rent": {
        "label": "Warmmiete",
        "value": null
    },
    "service_charge": {
        "label": "Nebenkosten",
        "value": null
    },
    "heating_costs": {
        "label": "Heizkosten",
        "value": null
    },
    "other_costs": {
        "label": "Nicht umlegbare Kosten",
        "value": null
    },
    "parking_space_price": {
        "label": "Stellplatz-Preis",
        "value": null
    },
    "plot_area": {
        "label": "Grundstücksfläche ca.",
        "value": null
    },
    "additional_area": {
        "label": "Weitere Fläche",
        "value": null
    },
    "usable_floor_space": {
        "label": "Nutzfläche",
        "value": null
    },
    "balcony_space": {
        "label": "Balkon/Terrasse Fläche ca.",
        "value": 14
    },
    "net_floor_space": {
        "label": "Nutzfläche ca.",
        "value": null
    },
    "total_floor_space": {
        "label": "Gesamtfläche ca.",
        "value": null
    },
    "cubature": {
        "label": "Kubatur",
        "value": null
    },
    "cellar_space": {
        "label": "Translation missing: de.simple_form.labels.defaults.cellar_space ca.",
        "value": null
    },
    "yield_actual": {
        "label": "Rendite Ist",
        "value": null
    },
    "yield_target": {
        "label": "Rendite Soll",
        "value": null
    },
    "co2_emission": {
        "label": "CO2-Emissionen",
        "value": null
    },
    "distance_to_mrs": {
        "label": "Fahrzeit nächster Hauptbahnhof",
        "value": null
    },
    "distance_to_fm": {
        "label": "Fahrzeit nächste Autobahn",
        "value": null
    },
    "distance_to_pt": {
        "label": "Fußweg zu öffentl. Verkehrsmitteln",
        "value": null
    },
    "distance_to_airport": {
        "label": "Fahrzeit nächster Flughafen",
        "value": null
    },
    "number_of_bed_rooms": {
        "label": "Anzahl Schlafzimmer",
        "value": 2
    },
    "number_of_bath_rooms": {
        "label": "Anzahl Badezimmer",
        "value": 2
    },
    "parking_space_number": {
        "label": "Stellplatz Nr.",
        "value": null
    },
    "number_of_parking_spaces": {
        "label": "Anzahl Parkplätze",
        "value": 1
    },
    "last_refurbishment": {
        "label": "Letzte Modernisierung",
        "value": "2015"
    },
    "construction_year": {
        "label": "Baujahr ca.",
        "value": 1944
    },
    "rent_subsidy": {
        "label": "Hausgeld/Monat",
        "value": null
    },
    "tenancy": {
        "label": "Pacht",
        "value": null
    },
    "number_seats": {
        "label": "Plätze Gastraum",
        "value": null
    },
    "number_beds": {
        "label": "Anzahl an Betten",
        "value": null
    },
    "max_number_of_persons": {
        "label": "Max. Personenanzahl",
        "value": null
    },
    "corridor": {
        "label": "Flur",
        "value": null
    },
    "register_number": {
        "label": "Grundbuchblatt",
        "value": null
    },
    "number_of_balconies": {
        "label": "Anzahl Balkone",
        "value": 1
    },
    "number_of_terraces": {
        "label": "Anzahl Terrassen",
        "value": null
    },
    "condition": {
        "label": "Objektzustand",
        "value": "Neuwertig"
    },
    "interior_quality": {
        "label": "Qualität der Ausstattung",
        "value": "Luxus"
    },
    "flooring_type": {
        "label": "Bodenbelag",
        "value": null
    },
    "energy_certificate_availability": {
        "label": "Energieausweis",
        "value": "wird nicht benötigt"
    },
    "energy_certificate_creation_date": {
        "label": "Erstellungsdatum",
        "value": "NO_INFORMATION"
    },
    "building_energy_rating_type": {
        "label": "Energieausweistyp",
        "value": "NO_INFORMATION"
    },
    "firing_types": {
        "label": "Wesentlicher Energieträger",
        "value": "NO_INFORMATION"
    },
    "heating_type": {
        "label": "Heizungsart",
        "value": "Keine Angabe"
    },
    "parking_space_type": {
        "label": "Stellplatztyp",
        "value": "Außenstellplatz"
    },
    "construction_phase": {
        "label": "Bauphase",
        "value": null
    },
    "utilization_trade_site": {
        "label": "Nutzungsart",
        "value": null
    },
    "site_development_type": {
        "label": "Erschließung",
        "value": null
    },
    "site_constructible_type": {
        "label": "Bebaubar nach",
        "value": null
    },
    "garage_type": {
        "label": "Stellplatztyp",
        "value": null
    },
    "store_type": {
        "label": "Objekttyp",
        "value": null
    },
    "supply_type": {
        "label": "Zulieferung",
        "value": null
    },
    "apartment_type": {
        "label": "Wohnungstyp",
        "value": "Penthouse"
    },
    "building_type": {
        "label": "Haustyp",
        "value": null
    },
    "location_classification_type": {
        "label": "Lageart",
        "value": null
    },
    "investment_type": {
        "label": "Objektart",
        "value": null
    },
    "contract_type": {
        "label": "Art des Vermittlungsauftrages",
        "value": null
    },
    "short_term_accomodation_type": {
        "label": "Wohnart",
        "value": null
    },
    "gender": {
        "label": "Geschlecht",
        "value": null
    },
    "pets_allowed": {
        "label": "Haustiere erlaubt",
        "value": null
    },
    "rented": {
        "label": "Vermietet",
        "value": false
    },
    "lodger_flat": {
        "label": "Einliegerwohnung",
        "value": false
    },
    "lift": {
        "label": "Personenaufzug",
        "value": true
    },
    "cellar": {
        "label": "Keller",
        "value": true
    },
    "barrier_free": {
        "label": "Barrierefrei",
        "value": false
    },
    "guest_toilet": {
        "label": "Gäste-WC",
        "value": false
    },
    "built_in_kitchen": {
        "label": "Einbauküche",
        "value": true
    },
    "balcony": {
        "label": "Balkon / Terrasse",
        "value": true
    },
    "garden": {
        "label": "Garten / -mitbenutzung",
        "value": false
    },
    "monument": {
        "label": "Denkmalschutzobjekt",
        "value": false
    },
    "ramp": {
        "label": "Rampe",
        "value": false
    },
    "construction_year_unknown": {
        "label": "Baujahr unbekannt",
        "value": false
    },
    "flat_share_suitable": {
        "label": "WG-geeignet",
        "value": false
    },
    "certificate_of_eligibility_needed": {
        "label": "Wohnberechtigungsschein erforderlich",
        "value": false
    },
    "price_on_inquiry": {
        "label": "Preis auf Anfrage",
        "value": false
    },
    "heating_costs_in_service_charge": {
        "label": "Heizkosten in Nebenkosten enthalten",
        "value": false
    },
    "short_term_constructible": {
        "label": "Kurzfristig bebaubar",
        "value": false
    },
    "building_permission": {
        "label": "Baugenehmigung",
        "value": false
    },
    "demolition": {
        "label": "Abriss",
        "value": false
    },
    "has_canteen": {
        "label": "Kantine / Cafeteria",
        "value": false
    },
    "kitchen_complete": {
        "label": "Küche vorhanden",
        "value": false
    },
    "high_voltage": {
        "label": "Starkstrom",
        "value": false
    },
    "terrace": {
        "label": "Terrasse",
        "value": false
    },
    "auto_lift": {
        "label": "Hebebühne",
        "value": false
    },
    "goods_lift": {
        "label": "Lastenaufzug",
        "value": false
    },
    "crane_runway": {
        "label": "Kranbahn Traglast",
        "value": false
    },
    "energy_consumption_contains_warm_water": {
        "label": "Energieverbrauch für Warmwasser enthalten",
        "value": false
    },
    "summer_residence_practical": {
        "label": "Als Ferienwohnung geeignet",
        "value": false
    },
    "non_smoker": {
        "label": "Nur an Nichtraucher",
        "value": false
    },
    "free_from": {
        "label": "Einzugstermin",
        "value": null
    },
    "free_until": {
        "label": "Verfügbar bis",
        "value": null
    },
    "end_rental_date": {
        "label": "Das Angebot ist frei bis",
        "value": null
    },
    "property_status": {
        "id": 2,
        "name": "In Vorbereitung",
        "position": 2,
        "color": "#ed892b",
        "nonpublic": false
    },
    "broker": {
        "id": 1,
        "salutation": "mr",
        "academic_title": null,
        "first_name": "Max",
        "last_name": "Mustermann",
        "name": "Max Mustermann",
        "avatar": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/avatar/ASLYoUSnKDYGZR2ZuA7cB19e/thumb_profilbild.jpg",
        "avatar_url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/avatar/ASLYoUSnKDYGZR2ZuA7cB19e/profilbild.jpg",
        "old_crm_id": null,
        "position": "CEO",
        "email": "makler@propstack.de",
        "phone": "+49 030 399 282 39",
        "color": "#0d68de",
        "connected": true,
        "team_id": null,
        "department_ids": [],
        "abstract": null,
        "description": null,
        "custom_fields": {}
    },
    "project": {
        "title": "Colors of Reinickendorf"
    },
    "property_groups": [
        {
            "id": 23,
            "name": "foo",
            "super_group_id": null
        }
    ],
    "documents": [],
    "floorplans": [
        {
            "id": 5,
            "name": "niceundriss.pdf",
            "title": "niceundriss.pdf",
            "url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/floorplans/EKuaWsFFoCcwrYd92KRfaQ9B/plan/FWpUaaDpwKgkCrHXr4zf3Lxg/grundriss.pdf",
            "position": 1,
            "updated_at": "2019-10-08T14:16:29.481+02:00"
        }
    ],
    "links": [],
    "images": [
        {
            "id": 8,
            "is_floorplan": false,
            "is_private": false,
            "title": "Objekt",
            "tags": null,
            "position": 1,
            "url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/Objekt.jpg",
            "updated_at": "2019-07-16T21:46:13.892+02:00",
            "big_url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/big_Objekt.jpg",
            "medium_url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/medium_Objekt.jpg",
            "thumb_url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/thumb_Objekt.jpg",
            "small_thumb_url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/small_thumb_Objekt.jpg",
            "square_url": "https://dev-propstack.s3.eu-central-1.amazonaws.com/photos/EKuaWsFFoCcwrYd92KRfaQ9B/photo/bayDE6L8RZYbimGFH4mJtgNV/square_Objekt.jpg"
        }
    ]
}

Objekt-Stati lesen

GET https://api.propstack.de/v1/property_statuses

Ein Objekt hat in der Regel immer einen Status, z.B. "Verfügbar" oder "Verkauft". Über diesen Endpoint kann man sich alle möglichen Objekt-Stati ziehen, die ein Objekt haben kann.

{
    "data": [
        {
            "id": 274,
            "name": "Verfügbar",
            "position": 1,
            "color": "#009cde",
            "nonpublic": false
        },
        {
            "id": 276,
            "name": "Reserviert",
            "position": 3,
            "color": "#f55753",
            "nonpublic": false
        },
        {
            "id": 278,
            "name": "Verkauft",
            "position": 5,
            "color": "#10cfbd",
            "nonpublic": true
        }
    ]
}

Last updated