Mandanten abrufen
Gibt eine paginierte Liste aller Mandanten zurück.
Request
GET /api/oauth/v2/resource/tenancies
Header
| Header | Wert |
|---|---|
Authorization | Bearer {access_token} |
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
offset | integer | Nein | Startposition (Standard: 0) |
limit | integer | Nein | Anzahl 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
| Feld | Typ | Beschreibung |
|---|---|---|
data | Array | Liste der Mandanten |
data[].id | string (UUID) | Eindeutige Mandanten-ID |
data[].name | string | Name des Mandanten |
data[].abbreviation | string | null | Kürzel |
data[].color | string | null | Farbe als Hex-Code (z.B. #00adba) |
meta.total | integer | Gesamtanzahl der Mandanten |
meta.offset | integer | Aktuelle Startposition |
meta.limit | integer | Anzahl 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
| Status | Code | Beschreibung |
|---|---|---|
| 401 | invalid_client | Ungültiger oder fehlender Access Token |
| 403 | insufficient_scope | Scope company nicht vorhanden |