Kundengruppen eines Kunden abrufen

Gibt alle Kundengruppen zurück, die einem Kunden aktuell zugeordnet sind, sortiert nach interner ID aufsteigend.

Request

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

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

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

Hinweis: Der Endpoint nimmt keine offset- oder limit-Parameter entgegen. data enthält immer alle zugeordneten Kundengruppen, meta beschreibt die vollständige Menge.

Erforderlicher Scope: customers

Response

Erfolg (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
      "name": "VIP-Kunden",
      "description": "Kunden mit Premium-Vertrag",
      "color": "#74AFAD"
    }
  ],
  "meta": {
    "total": 1,
    "offset": 0,
    "limit": 1
  }
}

Response-Felder

Feld	Typ	Beschreibung
data	Array	Liste der dem Kunden zugeordneten Kundengruppen
data[].id	string (UUID)	Eindeutige ID der Kundengruppe
data[].name	string	Name der Kundengruppe
data[].description	string | null	Beschreibungstext
data[].color	string	Farbe als Hex-Code
meta.total	integer	Gesamtanzahl der zugeordneten Kundengruppen
meta.offset	integer	Immer 0 – der Endpoint paginiert nicht
meta.limit	integer	Entspricht meta.total – der Endpoint paginiert nicht

Beispiele

bash

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

Server

Client-ID

Client-Secret

Parameter

uuid *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
403	access_denied	Zugriff durch fehlende Berechtigung verweigert
404	not_found	Kunde nicht gefunden