Skip to main content
API resource

Bookings

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

GET /bookings/reference/{reference}

Get booking by reference

Try it

Returns one booking using its string booking reference.

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

Request contract

Path parameter

The booking must belong to the business identified by the supplied API key.

Parameter Type Required Example Description
reference string Required 1-WTKB000229 The unique booking reference.

Booking item booking

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.
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.
checkInDate date-time 2026-05-07T00:00:00Z The booking check-in date and time in UTC.
checkOutDate date-time 2026-05-08T00:00:00Z The booking check-out date and time in UTC.
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",
  "petNames": "Poppy",
  "numberOfPets": 1,
  "serviceId": 1,
  "checkInDate": "2026-05-07T00:00:00Z",
  "checkOutDate": "2026-05-08T00:00:00Z",
  "bookingPaid": false,
  "hasPayment": false
}
401
Missing or invalid API key application/json

The example contains sanitized customer and pet values.