Service Details

Returns the details of a single service.

Request

GET /api/oauth/v2/resource/services/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

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

Required scope: services

Response

Success (200 OK)

{
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-234567890123",
    "name": "Erstgespräch",
    "description": "Erstkonsultation für Neupatienten",
    "duration": 30,
    "durationBefore": 0,
    "durationAfter": 5,
    "directBooking": true,
    "isOnlineBookable": true,
    "showDuration": true,
    "price": 80.00,
    "priceVisible": true,
    "color": "#df3a7f",
    "icon": "stethoscope",
    "sort": 0,
    "type": null,
    "category": {
      "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"
        }
      ]
    },
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique service ID
data.name	string	Name of the service
data.description	string | null	Description text
data.duration	integer	Duration of the service in minutes
data.durationBefore	integer	Preparation time in minutes
data.durationAfter	integer	Follow-up time in minutes
data.directBooking	boolean	Whether direct booking is possible
data.isOnlineBookable	boolean	Whether the service is bookable online
data.showDuration	boolean	Whether the duration is shown in the booking calendar
data.price	number | null	Price in euros
data.priceVisible	boolean	Whether the price is publicly visible
data.color	string | null	Color as hex code (e.g. #df3a7f)
data.icon	string | null	Icon name
data.sort	integer	Sort order
data.type	string | null	null = regular service. Possible values: service_pause (break), service_pause_custom (custom break), official_holiday (public holiday), vacation (vacation), illness (sick leave)
data.category	object | null	Assigned category
data.category.id	string (UUID)	Unique category ID
data.category.name	string	Name of the category
data.category.description	string | null	Description text of the category
data.category.color	string	Color of the category as hex code
data.category.sort	integer	Sort order of the category
data.category.tenancies	Array	Assigned tenants of the category
data.category.tenancies[].id	string (UUID)	Tenant ID
data.category.tenancies[].name	string	Name of the tenant
data.category.tenancies[].abbreviation	string	Abbreviation
data.category.tenancies[].color	string	Color as hex code
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/services/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	Service not found