Skip to main content
API resource

Bookings

Retrieve booking records, dates, statuses and related booking information.

GET /bookings

List bookings

Try it

Returns a paginated collection of bookings available to the authenticated KennelBooker business.

Filter the collection with the optional request.* query parameters documented below.

Send the business API key in the X-Api-Key header.

Request contract

Booking query parameters

Every query parameter is optional. Parameter names include the request. prefix used by the API model binder.

Query parameter Request property Type Example Description
request.from From date-time 2026-05-01T00:00:00Z Returns bookings checking in on or after this date.
request.to To date-time 2026-05-31T23:59:59Z Returns bookings checking in on or before this date.
request.checkOutFrom CheckOutFrom date-time 2026-05-01T00:00:00Z Returns bookings checking out on or after this date.
request.checkOutTo CheckOutTo date-time 2026-05-31T23:59:59Z Returns bookings checking out on or before this date.
request.updatedSince UpdatedSince date-time 2026-05-01T00:00:00Z Returns bookings changed on or after this date. Use it to sync incrementally instead of re-reading everything.
request.bookingType BookingType string boarding Filters results by booking type.
request.status Status string new Filters results by booking status.
request.customerId CustomerId integer 165 Returns bookings belonging to one customer.
request.serviceId ServiceId integer 1 Returns bookings associated with one service.
request.search Search string KB000229 Applies the endpoint's free-text booking search.
request.page Page integer 1 The one-based page number. Defaults to 1.
request.pageSize PageSize integer 25 The requested number of records per page. Defaults to 25.

Response envelope

Property Type Example Description
page integer 1 The one-based page returned.
pageSize integer 5 The page size applied to the request.
totalRecords integer 151 The total number of bookings matching the filters.
totalPages integer 31 The number of available pages for the applied page size.
items array [...] The booking records returned for the current page.

Booking item items[]

Property Type Example Description
bookingId integer 229 The booking identifier.
bookingType string boarding The booking type.
reference string 1-WTKB000229 The booking reference.
status string new The current booking status.
customerId integer 165 The related customer identifier.
customerName string Example Customer The customer name returned for the booking.
customerPhone string +353 87 123 4567 The customer's primary phone number.
customerEmail string customer@example.com The customer's primary email address.
petNames string Poppy The pet names returned for the booking.
numberOfPets integer 1 The number of pets attached to the booking.
serviceId integer 1 The related service identifier.
roomName string Suite 1 The room assigned to the booking.
checkInDate date-time 2026-05-07T00:00:00Z The booking check-in date. The time of day is carried separately in checkInTime.
checkOutDate date-time 2026-05-08T00:00:00Z The booking check-out date. The time of day is carried separately in checkOutTime.
checkInTime string 09:15 The arrival time of day as 24-hour HH:mm, in the business's own local time. Absent when no specific arrival time is recorded.
checkOutTime string 17:30 The departure time of day as 24-hour HH:mm, in the business's own local time. Absent when no specific departure time is recorded.
checkInTimeSlot string am A short display label for the arrival time. Its format depends on booking type: a half-day slot such as am or pm for boarding, a formatted time for grooming, training and universal bookings. Display it, do not parse it.
checkOutTimeSlot string pm A short display label for the departure time. Set for boarding only; other booking types leave it empty.
cancellationReason string Customer rearranged travel The free-text reason recorded when the booking was cancelled. Optional, so it is absent from live bookings and from cancelled bookings where no reason was given.
cancellationDate date-time 2026-04-28T11:02:00Z When the booking was cancelled. Absent on live bookings.
createdDate date-time 2026-03-14T09:41:00Z When the booking was created.
updatedDate date-time 2026-04-02T16:20:00Z When the booking was last changed. Pair this with the request.updatedSince filter to sync incrementally.
bookingPaid boolean false Indicates whether the booking is marked as paid.
hasPayment boolean false Indicates whether the booking has an associated payment.

Responses

200
OK application/json
Response body
{
  "page": 1,
  "pageSize": 5,
  "totalRecords": 151,
  "totalPages": 31,
  "items": [
    {
      "bookingId": 229,
      "bookingType": "boarding",
      "reference": "WTKB000229",
      "status": "new",
      "customerId": 165,
      "customerName": "Example Customer",
      "customerPhone": "+353 87 123 4567",
      "customerEmail": "customer@example.com",
      "petNames": "Poppy",
      "numberOfPets": 1,
      "serviceId": 1,
      "roomName": "Suite 1",
      "checkInDate": "2026-05-07T00:00:00Z",
      "checkOutDate": "2026-05-08T00:00:00Z",
      "checkInTime": "09:15",
      "checkOutTime": "17:30",
      "checkInTimeSlot": "am",
      "checkOutTimeSlot": "pm",
      "bookingPaid": false,
      "hasPayment": false
    }
  ]
}
401
Missing or invalid API key application/json

The successful example is shortened to one booking item. The pagination totals describe the full matching collection.