Skip to main content

BookingLocation.groupName on the public API

Summary​

The Public API BookingLocation type now exposes groupName: the name of the location that the booked room belongs to. Partners can request it on booking and bookings queries (and anywhere else a Booking.location is returned) to show where an appointment takes place, rather than the room name.

What changed​

  • Added BookingLocation.groupName: String — the location name stored on the booking when it was made.
  • BookingLocation.name is unchanged and still returns the room's name.
  • This change is additive; existing queries continue to work without requesting the new field.

Integration guidance​

  • Showing where an appointment is: request groupName and display it as the appointment location. address is already the address of that location.
  • Nulls: groupName is null when no location name is stored on the booking (for example some older bookings). Fall back to name (the room) when you need a value.
  • Stored value: groupName reflects the location at the time of booking. Renaming or moving the room later does not change existing bookings.

Example​

query BookingLocation {
  booking(id: "BOOKING_ID") {
    id
    location {
      id
      name
      groupName
      address {
        address
        city
        postcode
        country
      }
    }
  }
}

See also​