Sign in
Group

Returns a specific group booking.

Retrieves a specific group booking with all its related blocks<br>You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'.

get/booking/v1/groups/{id}

Path parameters

idstring required

Id of the group booking to be retrieved.

Query parameters

expandstring[]

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

Response

Success

idstring required

Group id

namestring required

Name of the group

fromstring date-time nullable

Start date and time of the earliest block for this group<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>

tostring date-time nullable

End date and time of the latest block for this group<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>

commentstring nullable

Additional information and comments

bookerCommentstring nullable

Additional information and comment by the booker

hasActivePaymentAccountboolean

True if the booking has at least one active payment account, false otherwise. This is a read-only property and is not set by the client. It is used to determine if the booking has an active payment account without having to retrieve the payment account details.

createdstring date-time required

Date of creation<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>

modifiedstring date-time required

Date of last modification<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>

propertyIdsstring[] required

The list of property ids this group belongs to

Example response

{
  "id": "XPGMSXGF",
  "name": "apaleo Summer Festival 2027",
  "from": "2026-09-06T13:40:59.7493356+02:00",
  "to": "2026-09-13T13:40:59.7493356+02:00",
  "booker": {
    "title": "Mr",
    "gender": "Male",
    "firstName": "Jon",
    "middleInitial": "D",
    "lastName": "Doe",
    "email": "john.d@doe.com",
    "phone": "+4989123343",
    "address": {
      "addressLine1": "My Street 5",
      "postalCode": "12453",
      "city": "MyCity",
      "countryCode": "GB"
    }
  },
  "paymentAccount": {
    "accountNumber": "1111",
    "accountHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "isVirtual": false,
    "isActive": false
  },
  "hasActivePaymentAccount": false,
  "created": "0001-01-01T00:00:00Z",
  "modified": "0001-01-01T00:00:00Z",
  "blocks": [
    {
      "id": "MUC-HSGTDG",
      "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-06T13:40:59.7493356+02:00",
      "to": "2026-09-11T13:40:59.7493356+02:00",
      "blockedUnits": 10,
      "pickedReservations": 0,
      "created": "2026-09-01T13:40:59.7493356+02:00",
      "modified": "2026-09-01T13:40:59.7493356+02:00"
    },
    {
      "id": "MUC-JAIULS",
      "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"
      },
      "from": "2026-09-07T13:40:59.7493356+02:00",
      "to": "2026-09-13T13:40:59.7493356+02:00",
      "blockedUnits": 8,
      "pickedReservations": 3,
      "created": "2026-09-01T13:40:59.7493356+02:00",
      "modified": "2026-09-01T13:40:59.7493356+02:00"
    }
  ],
  "propertyIds": [
    "MUC"
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.