Interessenten & Leads

Interessenten & Leads

1.0.0OAS 3.0

Nimmt Anfragen zu Objekten entgegen, führt Suchprofile und gleicht beides
automatisch ab. Jede Anfrage bekommt eine nachvollziehbare Bewertung, damit
knappe Besichtigungsplätze an die passenden Interessenten gehen.

Interessentendaten sind personenbezogen. Jeder Datensatz trägt deshalb ein
aufbewahrung_bis; nach Ablauf wird nächtlich anonymisiert. Ein Löschverlangen
setzen Sie über POST /interessenten/{id}/loeschung sofort um.

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)

Interessenten

Interessenten auflisten

get

Query Parameters

suchprofil_aktivboolean
limitinteger

Default:25

>= 1<= 100

cursorstring

Response

application/json

Trefferliste

datenarray
Show Child Parameters
seiteobject

Cursor-basierte Paginierung.

Show Child Parameters
get/interessenten
 
application/json