Skip to main content
POST
Refresh Connection

Authorizations

x-api-key
string
header
required

Dein Business OS API Key. Erstelle einen unter app.business-os.de → API Keys.

Path Parameters

id
string
required

Connection-ID

Body

application/json
return_to
string<uri>

Redirect-URL nach erneuter Autorisierung

Example:

"https://app.business-os.de/close"

Response

Refresh gestartet. Enthält ggf. eine Widget-URL wenn erneute Autorisierung nötig.

Antwort beim Refresh einer Verbindung. Wenn der serverseitige Refresh sofort durchläuft (keine erneute User-Autorisierung nötig), wird refreshed: true zurückgegeben. Andernfalls kommt eine Connect-URL für die erneute Autorisierung.

refreshed
boolean

true wenn der Refresh server-seitig sofort abgeschlossen wurde. Wenn nicht gesetzt, muss der User über connect_url erneut autorisieren.

Example:

true

connect_url
string<uri>

URL zum Connect Widget (nur wenn erneute Autorisierung nötig)

Example:

"https://psd2.business-os.de/connect?token=xxx"

expires_at
string<date-time>

Ablaufzeitpunkt der Session

Example:

"2026-03-24T04:26:21Z"