Kunden abrufen

Gibt eine paginierte Liste aller Kunden des Unternehmens zurück.

Request

GET /api/oauth/v2/resource/customers

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)
term	string	Nein	Suchbegriff für Name (min. 3 Zeichen)
socialNumber	string	Nein	Sozialversicherungsnummer (exakte Übereinstimmung)
email	string	Nein	E-Mail-Adresse (exakte Übereinstimmung)
phone	string	Nein	Telefonnummer (exakte Übereinstimmung)

Hinweis: Alle Suchfilter können kombiniert werden (UND-Verknüpfung). So kann z.B. gleichzeitig nach socialNumber und term gefiltert werden.

Response

Erfolg (200 OK)

{
  "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"
        }
      ]
    }
  ],
  "meta": {
    "total": 1200,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

Feld	Typ	Beschreibung
data	Array	Liste der Kunden
data[].id	string (UUID)	Eindeutige Kunden-ID
data[].title	string | null	Titel (z.B. Dr., Mag.)
data[].firstName	string | null	Vorname
data[].lastName	string | null	Nachname
data[].email	string | null	E-Mail-Adresse
data[].phone	string | null	Telefonnummer
data[].birthday	string | null	Geburtsdatum (YYYY-MM-DD)
data[].socialNumber	string | null	Sozialversicherungsnummer
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
meta.total	integer	Gesamtanzahl der Kunden
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/customers?offset=0&limit=50&term=Muster&socialNumber=1234010190&email=anna.muster%40example.com&phone=%2B43+664+1234567" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

term string

socialNumber string

email string

phone string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope customers nicht vorhanden