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'.
Query parameters
Return blocks for the specific group
Return blocks filtered by properties
Return blocks filtered by statuses
Return blocks with any of the specified unit groups
Return blocks with any of the specified rate plans
Return blocks with any of the specified time slice definitions
Return blocks with any of the specified unit group types
The time slice template, defaults to 'over night'
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 (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
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 (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
Items per page. Default: 500. Maximum: 500.
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
OK
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"
},
"from": "2026-09-06T17:00:00+02:00",
"to": "2026-09-07T11:00:00+02:00",
"pickedReservations": 0,
"created": "0001-01-01T00:00:00Z",
"modified": "0001-01-01T00:00:00Z",
"timeSlices": [
{
"from": "2026-09-06T17:00:00+02:00",
"to": "2026-09-07T11:00:00+02: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"
},
"grossDailyRate": {
"amount": 190,
"currency": "EUR"
},
"from": "2026-09-06T17:00:00+02:00",
"to": "2026-09-08T11:00:00+02:00",
"pickedReservations": 1,
"marketSegment": {
"id": "CORP",
"code": "CORP",
"name": "Corporate Groups"
},
"created": "0001-01-01T00:00:00Z",
"modified": "0001-01-01T00:00:00Z",
"timeSlices": [
{
"from": "2026-09-06T17:00:00+02:00",
"to": "2026-09-07T11:00:00+02:00",
"blockedUnits": 2,
"pickedUnits": 1,
"baseAmount": {
"grossAmount": 115,
"netAmount": 100,
"vatType": "Special",
"vatPercent": 15,
"currency": "EUR"
},
"totalGrossAmount": {
"amount": 120,
"currency": "EUR"
}
},
{
"from": "2026-09-07T17:00:00+02:00",
"to": "2026-09-08T11:00:00+02: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 recorded changes to this endpoint across all 1 revision of this API.