Objektverwaltung

Objektverwaltung

1.0.0OAS 3.0

Das führende Datenmodell für alle vermarkteten Objekte – Wohnungen, Häuser und
Gewerbeflächen. Objekte sind die Grundlage für Exposés, Matching und Bewertung.

Der Bestand lässt sich über OpenImmo befüllen und exportieren, sodass
bestehende Maklersoftware ohne Zwischenschritt angebunden werden kann.

API Base URL
  • Server 1:https://api.maklerportal.example/v1

    Produktion

  • Server 2:https://sandbox.api.maklerportal.example/v1

    Sandbox

Security
apiKey (apiKey)

Jeder Aufruf trägt einen API-Schlüssel im Header apikey. Den Schlüssel
erzeugen Sie im Maklerportal unter “Meine Anwendungen”; er wird genau einmal
angezeigt.

An jedem Schlüssel hängen die Scopes, die er nutzen darf. Fehlt einer,
antwortet die API mit 403 und code: "scope_fehlt"; der fehlende Scope
steht in details[].feld.

Additional Information
Contact API-Support Objektwerk GmbH (api-support@objektwerk.example)

Objekte

Objekte auflisten

get

Query Parameters

statusstring

Allowed values:entwurfaktivreserviertverkauftvermietetarchiviert

Example:aktiv

typstring

Allowed values:wohnunghausgrundstueckgewerbestellplatz

Example:wohnung

plzstring

Filter auf die Postleitzahl.

Example:20251

limitinteger

Default:25

>= 1<= 100

cursorstring

Response

application/json

Trefferliste

datenarray
Show Child Parameters
seiteobject

Cursor-basierte Paginierung.

Show Child Parameters
get/objekte
 
application/json