Skip to content

Kunde anzeigen

Gibt die Details eines einzelnen Kunden zurück.

Request

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

HeaderWert
AuthorizationBearer {access_token}

URL-Parameter

ParameterTypPflichtBeschreibung
uuidstringJaEindeutige Kunden-ID

Response

Erfolg (200 OK)

json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": null,
    "firstName": "Anna",
    "lastName": "Muster",
    "email": "anna.muster@example.com",
    "phone": "+43 664 1234567",
    "birthday": "1985-04-12",
    "socialNumber": "1234 120485",
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response-Felder

FeldTypBeschreibung
data.idstring (UUID)Eindeutige Kunden-ID
data.titlestring | nullTitel (z.B. Dr., Mag.)
data.firstNamestring | nullVorname
data.lastNamestring | nullNachname
data.emailstring | nullE-Mail-Adresse
data.phonestring | nullTelefonnummer
data.birthdaystring | nullGeburtsdatum (YYYY-MM-DD)
data.socialNumberstring | nullSozialversicherungsnummer
data.tenanciesArrayZugeordnete Mandanten
data.tenancies[].idstring (UUID)Mandanten-ID
data.tenancies[].namestringName des Mandanten
data.tenancies[].abbreviationstringKürzel
data.tenancies[].colorstringFarbe als Hex-Code
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/customers/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Mögliche Fehler

StatusCodeBeschreibung
401invalid_clientUngültiger oder fehlender Access Token
403insufficient_scopeScope customers nicht vorhanden
404not_foundKunde nicht gefunden

Offisy GmbH