Benutzer anzeigen

Gibt die Details eines einzelnen Benutzers zurück.

Request

GET /api/oauth/v2/resource/users/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string (UUID)	Ja	Eindeutige Benutzer-ID

Erforderlicher Scope: users

Response

Erfolg (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": null,
    "firstName": "Maria",
    "lastName": "Muster",
    "abbreviation": "MM",
    "sex": 1,
    "email": "maria.muster@example.com",
    "color": "#00adba",
    "sort": 0,
    "isBookable": true,
    "isDoctor": false,
    "showBookingWeeks": 4,
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige Benutzer-ID
data.title	string | null	Titel (z.B. „Dr.")
data.firstName	string | null	Vorname
data.lastName	string | null	Nachname
data.abbreviation	string | null	Kürzel
data.sex	integer | null	Geschlecht (0 = männlich, 1 = weiblich)
data.email	string | null	E-Mail-Adresse
data.color	string | null	Farbe als Hex-Code (z.B. #00adba)
data.sort	integer	Sortierreihenfolge
data.isBookable	boolean	Ob der Benutzer buchbar ist
data.isDoctor	boolean	Ob der Benutzer als Arzt/Ärztin markiert ist
data.showBookingWeeks	integer | null	Anzahl der im Buchungskalender angezeigten Wochen
data.tenancies	Array	Zugeordnete Mandanten
data.tenancies[].id	string (UUID)	Mandanten-ID
data.tenancies[].name	string	Name des Mandanten
data.tenancies[].abbreviation	string	Kürzel
data.tenancies[].color	string	Farbe als Hex-Code

Hinweis: Die API gibt weitere interne Felder zurück, die hier nicht dokumentiert sind. Verwende nur die hier beschriebenen Felder — alle anderen können sich ohne Vorankündigung ändern.

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/users/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *integer

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope users nicht vorhanden
404	not_found	Benutzer nicht gefunden