APapaleo
Availability

Get a list of all available services in a property

Changed on

Get the list of available services for a specific property and time period.<br>You must have this scope: 'availability.read'.<br>For fine-grained clients, you must have this permission: 'core.services_availability.read'.

get/availability/v1/services

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/availability/v1/services
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: availability.read, admin

Query parameters

propertyIdstring required

The property id

fromstring date required

First day of the requested time period. The given day will be included in the response.

tostring date required

Last day of the requested time period. The given day will be included in the response.

timeSliceTemplate'DayUse' | 'OverNight'

The time slice template, defaults to 'over night'

timeSliceDefinitionIdsstring[]

The time slice definition ids

channelCodesstring[]

The channel code used to filter the services

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Return all available services.

countinteger required

Total count of items

Example response

{
  "timeSlices": [
    {
      "from": "2026-10-09T17:00:00+02:00",
      "to": "2026-10-10T11:00:00+02:00",
      "services": [
        {
          "service": {
            "id": "MUC-YOGA",
            "code": "YOGA",
            "name": "Sun Salutation",
            "description": "Start the day with a private Yoga session with one of our certified trainers."
          },
          "quantity": 8,
          "soldCount": 5,
          "availableCount": 3,
          "serviceDate": "2026-10-09",
          "block": {
            "definite": 1,
            "tentative": 4,
            "optional": 1,
            "optionalDeducting": 1,
            "picked": 2,
            "remaining": 3
          }
        }
      ]
    },
    {
      "from": "2026-10-10T11:00:00+02:00",
      "to": "2026-10-11T11:00:00+02:00",
      "services": [
        {
          "service": {
            "id": "MUC-BRKF",
            "code": "BRKF",
            "name": "Breakfast",
            "description": "Best breakfast on this side of the Weißwurstäquator."
          },
          "quantity": 11,
          "soldCount": 4,
          "availableCount": 7,
          "serviceDate": "2026-10-11",
          "block": {
            "definite": 4,
            "tentative": 1,
            "optional": 2,
            "optionalDeducting": 1,
            "picked": 3,
            "remaining": 2
          }
        }
      ]
    }
  ],
  "count": 2
}

Changes