Kundengruppen abrufen

Gibt eine paginierte Liste aller Kundengruppen des Unternehmens zurück, sortiert nach interner ID aufsteigend.

Request

GET /api/oauth/v2/resource/customers/groups

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)

Response

Erfolg (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Stammkunden",
      "description": "Kunden mit regelmäßigen Terminen",
      "color": "#74AFAD"
    }
  ],
  "meta": {
    "total": 4,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

Feld	Typ	Beschreibung
data	Array	Liste der Kundengruppen
data[].id	string (UUID)	Eindeutige Kundengruppen-ID
data[].name	string	Name der Kundengruppe
data[].description	string | null	Beschreibung der Kundengruppe
data[].color	string	Farbe als Hex-Code (z.B. #74AFAD)
meta.total	integer	Gesamtanzahl der Kundengruppen
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/groups?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

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
403	access_denied	Zugriff durch fehlende Berechtigung verweigert