Skip to content

Mandanten abrufen

Gibt eine paginierte Liste aller Mandanten zurück.

Request

GET /api/oauth/v2/resource/tenancies

HeaderWert
AuthorizationBearer {access_token}

Query-Parameter

ParameterTypPflichtBeschreibung
offsetintegerNeinStartposition (Standard: 0)
limitintegerNeinAnzahl Ergebnisse (Standard: 50, Max: 200)

Erforderlicher Scope: company

Response

Erfolg (200 OK)

json
{
  "data": [
    {
      "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "name": "Ordination Muster",
      "abbreviation": "OM",
      "color": "#00adba"
    }
  ],
  "meta": {
    "total": 2,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

FeldTypBeschreibung
dataArrayListe der Mandanten
data[].idstring (UUID)Eindeutige Mandanten-ID
data[].namestringName des Mandanten
data[].abbreviationstring | nullKürzel
data[].colorstring | nullFarbe als Hex-Code (z.B. #00adba)
meta.totalintegerGesamtanzahl der Mandanten
meta.offsetintegerAktuelle Startposition
meta.limitintegerAnzahl der zurückgegebenen Einträge
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/tenancies?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Mögliche Fehler

StatusCodeBeschreibung
401invalid_clientUngültiger oder fehlender Access Token
403insufficient_scopeScope company nicht vorhanden

Offisy GmbH