Category Details

Returns the details of a single service category.

Request

GET /api/oauth/v2/resource/service/categories/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

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

Required scope: services

Response

Success (200 OK)

{
  "data": {
    "id": "d4e5f6a7-b8c9-0123-defa-123456789012",
    "name": "Allgemein",
    "description": "Allgemeine Leistungen für Neupatienten",
    "color": "#74AFAD",
    "sort": 0,
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique category ID
data.name	string	Name of the category
data.description	string | null	Description text
data.color	string	Color as hex code (e.g. #74AFAD)
data.sort	integer	Sort order
data.tenancies	Array	Assigned tenants
data.tenancies[].id	string (UUID)	Tenant ID
data.tenancies[].name	string	Name of the tenant
data.tenancies[].abbreviation	string	Abbreviation
data.tenancies[].color	string	Color as hex code

Note: The API returns additional internal fields not documented here. Only use the fields described here — all others may change without notice.

Beispiele

bash

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

Server

Client-ID

Client-Secret

Parameter

uuid *integer

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope services not present
404	not_found	Category not found