Customer Group Details

Returns the details of a single customer group.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique customer group ID

Response

Success (200 OK)

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Stammkunden",
    "description": "Kunden mit regelmäßigen Terminen",
    "color": "#74AFAD"
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique customer group ID
data.name	string	Name of the customer group
data.description	string | null	Description of the customer group
data.color	string	Color as hex code (e.g. #74AFAD)

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/customers/groups/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -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 — e.g. if the customer group belongs to a company you have no cooperation with. If a cooperation exists between the companies, the request returns the data as normal
404	not_found	Customer group not found