List Ware Categories

Returns a paginated list of ware categories, sorted by internal ID ascending. This endpoint needs no additional license.

Request

GET /api/oauth/v2/resource/wares/categories

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": "d4e5f6a7-b8c9-0123-defa-123456789012",
      "name": "Hilfsmittel",
      "color": "#74AFAD",
      "tenancies": ["f0e1d2c3-b4a5-6789-fedc-ba9876543210"]
    }
  ],
  "meta": {
    "total": 12,
    "offset": 0,
    "limit": 50
  }
}

Response fields

Field	Type	Description
data	Array	List of ware categories
data[].id	string (UUID)	Unique ID of the category
data[].name	string	Name of the category
data[].color	string	Color as hex code (e.g. #74AFAD)
data[].tenancies	Array<string (UUID)>	IDs of the assigned tenants
meta.total	integer	Total number of categories
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/wares/categories?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 wares not present