Skip to main content
API fundamentals

Filtering bookings

Narrow booking collections by date, booking type, status, customer, service or free-text search.

Filter parameters

All parameters are optional. Use the exact query-string names shown below, including the request. prefix exposed by the API.

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.

Combine filters

Supply multiple query parameters to narrow the collection before pagination is applied.

Filtered booking request
curl --request GET \
  --url "https://api.kennelbooker.com/api/v1/bookings?request.from=2026-05-01T00%3A00%3A00Z&request.to=2026-05-31T23%3A59%3A59Z&request.bookingType=boarding&request.status=new&request.page=1&request.pageSize=25" \
  --header "X-Api-Key: kb_live_your_api_key" \
  --header "Accept: application/json"

Date filters

Send date-time values using ISO 8601. Including an explicit timezone, such as Z for UTC, avoids differences between server and integration timezones.

request.from and request.to are nullable. Send either boundary independently or combine them into a date range.

Customer and service filters

One customer

Use request.customerId with a KennelBooker customer identifier.

request.customerId=165

One service

Use request.serviceId with the required service identifier.

request.serviceId=1

Sorting

Custom sorting is not currently supported. The implemented BookingSearchRequest has no sort field or direction property. Do not send undocumented sorting parameters; they may be ignored or rejected.