Block

Returns a list of blocks

Returns a list of all blocks, filtered by the specified parameters. If no parameters are set, returns the entire list.<br>You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.blocks.read'.

get/booking/v0-nsfw/blocks

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/booking/v0-nsfw/blocks
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: blocks.read, reservations.read, reservations.manage, admin

Query parameters

groupIdstring

Return blocks for the specific group

propertyIdsstring[]

Return blocks filtered by properties

statusstring[]

Return blocks filtered by statuses

unitGroupIdsstring[]

Return blocks with any of the specified unit groups

ratePlanIdsstring[]

Return blocks with any of the specified rate plans

timeSliceDefinitionIdsstring[]

Return blocks with any of the specified time slice definitions

unitGroupTypesstring[]

Return blocks with any of the specified unit group types

timeSliceTemplate'DayUse' | 'OverNight'

The time slice template, defaults to 'over night'

fromstring date-time

The start of the time range. All blocks that are overlapping with the interval specified by from and to will be returned<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time

The end of the time range. All blocks that are overlapping with the interval specified by from and to will be returned<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

dateFilter'BlockDate' | 'Modified'

Filter by date and time attributes of block. Use in combination with the 'To' and 'From' attributes. All filters will check if the date specified by the filter type is between from (included) and to (excluded).

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.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions, timeSlices. All other values will be silently ignored.

Response

countinteger required

Total count of items

Example response

{
  "blocks": [
    {
      "id": "MUC-HSGTDG",
      "group": {
        "id": "XPGMSXGF",
        "name": "apaleo Summer Festival 2027"
      },
      "status": "Tentative",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "ratePlan": {
        "id": "MUC-NONREF_SGL",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Non Refundable",
        "isSubjectToCityTax": false
      },
      "unitGroup": {
        "id": "MUC-SGL",
        "code": "SGL",
        "name": "Single",
        "description": "Single",
        "type": "BedRoom"
      },
      "grossDailyRate": {
        "amount": 160,
        "currency": "EUR"
      },
      "rateIncludesCityTax": false,
      "from": "2026-11-04T17:00:00+01:00",
      "to": "2026-11-05T11:00:00+01:00",
      "pickedReservations": 0,
      "created": "0001-01-01T00:00:00Z",
      "modified": "0001-01-01T00:00:00Z",
      "timeSlices": [
        {
          "from": "2026-11-04T17:00:00+01:00",
          "to": "2026-11-05T11:00:00+01:00",
          "blockedUnits": 2,
          "pickedUnits": 0,
          "baseAmount": {
            "grossAmount": 115,
            "netAmount": 100,
            "vatType": "Special",
            "vatPercent": 15,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 120,
            "currency": "EUR"
          }
        }
      ]
    },
    {
      "id": "MUC-JAIULS",
      "group": {
        "id": "XPGMSXGF",
        "name": "apaleo Summer Festival 2027"
      },
      "status": "Definite",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "ratePlan": {
        "id": "MUC-NONREF_DBL",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Non Refundable",
        "isSubjectToCityTax": false
      },
      "unitGroup": {
        "id": "MUC-DBL",
        "code": "DBL",
        "name": "Double",
        "description": "Double",
        "type": "BedRoom"
      },
      "marketSegment": {
        "id": "CORP",
        "code": "CORP",
        "name": "Corporate Groups"
      },
      "grossDailyRate": {
        "amount": 190,
        "currency": "EUR"
      },
      "rateIncludesCityTax": false,
      "from": "2026-11-04T17:00:00+01:00",
      "to": "2026-11-06T11:00:00+01:00",
      "pickedReservations": 1,
      "created": "0001-01-01T00:00:00Z",
      "modified": "0001-01-01T00:00:00Z",
      "timeSlices": [
        {
          "from": "2026-11-04T17:00:00+01:00",
          "to": "2026-11-05T11:00:00+01:00",
          "blockedUnits": 2,
          "pickedUnits": 1,
          "baseAmount": {
            "grossAmount": 115,
            "netAmount": 100,
            "vatType": "Special",
            "vatPercent": 15,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 120,
            "currency": "EUR"
          }
        },
        {
          "from": "2026-11-05T17:00:00+01:00",
          "to": "2026-11-06T11:00:00+01:00",
          "blockedUnits": 3,
          "pickedUnits": 1,
          "baseAmount": {
            "grossAmount": 115,
            "netAmount": 100,
            "vatType": "Special",
            "vatPercent": 15,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 120,
            "currency": "EUR"
          }
        }
      ]
    }
  ],
  "count": 2
}

Changes

No operation changes recorded.