List Customer's Groups

Returns all customer groups currently assigned to a customer, sorted by internal ID ascending.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string (UUID)	Yes	Unique customer ID

Note: The endpoint does not accept offset or limit parameters. data always contains all assigned customer groups, and meta describes the complete set.

Required scope: customers

Response

Success (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
      "name": "VIP customers",
      "description": "Customers with a premium contract",
      "color": "#74AFAD"
    }
  ],
  "meta": {
    "total": 1,
    "offset": 0,
    "limit": 1
  }
}

Response fields

Field	Type	Description
data	Array	List of customer groups assigned to the customer
data[].id	string (UUID)	Unique customer group ID
data[].name	string	Name of the customer group
data[].description	string | null	Description text
data[].color	string	Color as a hex code
meta.total	integer	Total number of assigned customer groups
meta.offset	integer	Always 0 — the endpoint does not paginate
meta.limit	integer	Equal to meta.total — the endpoint does not paginate

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

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope customers not present
403	access_denied	Access denied due to missing permission
404	not_found	Customer not found