Search
K
Besichtigungstermine

Besichtigungstermine

1.0.0OAS 3.0

Plant Einzel- und Sammelbesichtigungen, verwaltet Zu- und Absagen und sammelt
Rückmeldungen nach dem Termin ein.

Die API kennt zwei Modelle: feste Termine, zu denen Sie einladen, und
Verfügbarkeitsfenster, aus denen Interessenten selbst einen Platz wählen.
Beides lässt sich pro Objekt mischen.

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)

Termine

Termine auflisten

get

Query Parameters

objekt_idstring

Example:obj_8f2c1a

vonstring(date-time)
bisstring(date-time)
statusstring

Allowed values:geplantbestaetigtdurchgefuehrtabgesagt

Example:bestaetigt

Response

application/json

Trefferliste

datenarray
Show Child Parameters
seiteobject

Cursor-basierte Paginierung.

Show Child Parameters
get/termine
 
application/json

Termin anlegen

post

Body

application/json

TerminAnlegen

objekt_idstringrequired

Example:obj_8f2c1a

artstringrequired

Allowed values:einzelsammeldigital

Example:einzel

beginnstring(date-time)required

Example:2026-09-03T16:00:00+02:00

dauer_minuteninteger

Default:30

>= 10<= 240

plaetzeinteger

Nur bei art: sammel auszuwerten.

>= 1

Example:12

treffpunktstring

<= 200 characters

Example:Vor dem Hauseingang, Falkenried 42

hinweisstring

<= 500 characters

Example:Bitte Ausweis mitbringen, die Wohnung ist bewohnt.

Response

application/json

Angelegt

Termin

objekt_idstringrequired

Example:obj_8f2c1a

artstringrequired

Allowed values:einzelsammeldigital

Example:einzel

beginnstring(date-time)required

Example:2026-09-03T16:00:00+02:00

dauer_minuteninteger

Default:30

>= 10<= 240

plaetzeinteger

Nur bei art: sammel auszuwerten.

>= 1

Example:12

treffpunktstring

<= 200 characters

Example:Vor dem Hauseingang, Falkenried 42

hinweisstring

<= 500 characters

Example:Bitte Ausweis mitbringen, die Wohnung ist bewohnt.

idstring

Example:trm_9a44

statusstring

Allowed values:geplantbestaetigtdurchgefuehrtabgesagt

Example:bestaetigt

zusagen_anzahlinteger

Example:8

warteliste_anzahlinteger

Example:2

angelegt_amstring(date-time)

Example:2026-08-20T11:02:10Z

post/termine

Body

{ "objekt_id": "obj_8f2c1a", "art": "einzel", "beginn": "2026-09-03T16:00:00+02:00", "dauer_minuten": 30, "treffpunkt": "Vor dem Hauseingang, Falkenried 42" }
 
application/json

Termin abrufen

get

Path Parameters

terminIdstringrequired

Example:trm_9a44

Response

application/json

Termin

Termin

objekt_idstringrequired

Example:obj_8f2c1a

artstringrequired

Allowed values:einzelsammeldigital

Example:einzel

beginnstring(date-time)required

Example:2026-09-03T16:00:00+02:00

dauer_minuteninteger

Default:30

>= 10<= 240

plaetzeinteger

Nur bei art: sammel auszuwerten.

>= 1

Example:12

treffpunktstring

<= 200 characters

Example:Vor dem Hauseingang, Falkenried 42

hinweisstring

<= 500 characters

Example:Bitte Ausweis mitbringen, die Wohnung ist bewohnt.

idstring

Example:trm_9a44

statusstring

Allowed values:geplantbestaetigtdurchgefuehrtabgesagt

Example:bestaetigt

zusagen_anzahlinteger

Example:8

warteliste_anzahlinteger

Example:2

angelegt_amstring(date-time)

Example:2026-08-20T11:02:10Z

get/termine/{terminId}
 
application/json