Skip to main content
API resource

Bookings

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

GET /bookings/checkout

List bookings checking out

Try it

Returns the bookings checking out on the supplied date.

Supply the required date query parameter using the YYYY-MM-DD format.

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

Request contract

Query parameter

The date is required and is applied within the business identified by the supplied API key.

Parameter Type Required Example Description
date date-time Required 2026-05-08 The check-out date in YYYY-MM-DD format.

Booking item array[]

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
[
  {
    "bookingId": 229,
    "bookingType": "boarding",
    "reference": "1-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
  },
  {
    "bookingId": 230,
    "bookingType": "boarding",
    "reference": "1-WTKB000230",
    "status": "confirmed",
    "customerId": 166,
    "customerName": "Another Customer",
    "customerPhone": "+353 87 765 4321",
    "customerEmail": "another.customer@example.com",
    "petNames": "Luna",
    "numberOfPets": 1,
    "serviceId": 1,
    "roomName": "Suite 2",
    "checkInDate": "2026-05-07T00:00:00Z",
    "checkOutDate": "2026-05-08T00:00:00Z",
    "checkInTime": "09:15",
    "checkOutTime": "17:30",
    "checkInTimeSlot": "am",
    "checkOutTimeSlot": "pm",
    "bookingPaid": true,
    "hasPayment": true
  }
]
401
Missing or invalid API key application/json

The endpoint returns a JSON array of matching bookings. The example contains two sanitized booking records to demonstrate the collection format.