List Customer Groups

Returns a paginated list of all customer groups of the company, sorted by internal ID ascending.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

Query parameters

Parameter	Type	Required	Description
offset	integer	No	Start position (default: 0)
limit	integer	No	Number of results (default: 50, max: 200)

Response

Success (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 fields

Field	Type	Description
data	Array	List of customer groups
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)
meta.total	integer	Total number of customer groups
meta.offset	integer	Current start position
meta.limit	integer	Number of returned entries

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

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