Search Reservations

Search reservations with flexible filtering, sorting and pagination — and receive the full report enrichments (money, listing, guest, accounting, ...) that the legacy search-reservations endpoint used to surface.

Filters

Filters use bracket notation in the query string:

  • filter[<field>]=<value> — shorthand (defaults to eq, or implicit in when comma-separated).
  • filter[<field>][<operator>]=<value> — explicit operator.

Multiple operators on the same field are combined with logical AND, e.g.
filter[checkInDate][gte]=2026-01-01&filter[checkInDate][lt]=2026-02-01 returns reservations checking in during January 2026.

All date/time fields use listing timezone.

Identifier fields (string equality / set membership)

FieldOperatorsNotes
statuseq, ne, in, ninComma-separated value implies in
listingIdeq, inMatches the top-level listingId on the report (works for both legacy and v3 reservations)
confirmationCodeeq, inComma-separated value implies in
sourceeq, ine.g. direct, bookingCom

Date / range fields

FieldOperatorsFormatNotes
checkIneq, gte, gt, lte, ltYYYY-MM-DDTHH:mm:ss (listing TZ)Planned arrival datetime
checkInDategte, gt, lte, ltYYYY-MM-DD (listing TZ)Check-in date with day-boundary semantics. For exact day: gte=2026-01-15&lt=2026-01-16
checkInTimeeq, gte, gt, lte, ltHH:mm (listing TZ)Planned arrival time (string comparison)
checkOuteq, gte, gt, lte, ltYYYY-MM-DDTHH:mm:ss (listing TZ)Planned departure datetime
checkOutDategte, gt, lte, ltYYYY-MM-DD (listing TZ)Check-out date with day-boundary semantics
checkOutTimeeq, gte, gt, lte, ltHH:mm (listing TZ)Planned departure time (string comparison)
createdAteq, gte, gt, lte, ltISO 8601 datetimee.g. 2026-01-01T00:00:00Z

Sorting

Use the sort query parameter. Prefix the field with - for descending order.
Allowed fields: _id, checkIn, checkOut, createdAt. Default: -_id.

Pagination

Use skip (default 0) and limit (default 25, max 100). The response includes a pagination.hasMore flag.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
≥ 0
Defaults to 0

Number of records to skip

number
1 to 100
Defaults to 25

Maximum records to return

string
enum
Defaults to -_id

Sort field. Prefix with - for descending. Allowed: _id, checkIn, checkOut, createdAt

string

Reservation source in set (comma-separated). Equivalent to the bare filter[source] shorthand.

string

Reservation source equal to value

string

Reservation source — comma-separated for implicit IN, single value for implicit eq. E.g. direct,bookingCom

string

Confirmation code in set (comma-separated). Equivalent to the bare filter[confirmationCode] shorthand.

string

Confirmation code equal to value

string

Confirmation code — comma-separated for implicit IN, single value for implicit eq.

string

Listing ID in set (comma-separated). Equivalent to the bare filter[listingId] shorthand.

string

Listing ID equal to value

string

Listing ID — comma-separated for implicit IN, single value for implicit eq.

string

Status not in set (comma-separated)

string

Status in set (comma-separated). Equivalent to the bare filter[status] shorthand.

string

Status not equal to value

string

Status equal to value

string

Status — comma-separated for implicit IN, single value for implicit eq. E.g. confirmed,reserved

string

Reservation created strictly before timestamp (ISO 8601)

string

Reservation created on/before timestamp (ISO 8601)

string

Reservation created strictly after timestamp (ISO 8601)

string

Reservation created on/after timestamp (ISO 8601)

string

Reservation created exactly at timestamp (ISO 8601)

string

Check-out time on/before (HH:mm, listing TZ)

string

Check-out time on/after (HH:mm, listing TZ)

string

Check-out time exactly (HH:mm, listing TZ)

string

Check-out date strictly before (listing TZ, YYYY-MM-DD)

string

Check-out date on/before (listing TZ, YYYY-MM-DD)

string

Check-out date strictly after (listing TZ, YYYY-MM-DD)

string

Check-out date on/after (listing TZ, YYYY-MM-DD)

string

Check-out strictly before datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-out on/before datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-out strictly after datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-out on/after datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-out exactly at datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-in time on/before (HH:mm, listing TZ)

string

Check-in time on/after (HH:mm, listing TZ)

string

Check-in time exactly (HH:mm, listing TZ)

string

Check-in date strictly before (listing TZ, YYYY-MM-DD)

string

Check-in date on/before (listing TZ, YYYY-MM-DD)

string

Check-in date strictly after (listing TZ, YYYY-MM-DD)

string

Check-in date on/after (listing TZ, YYYY-MM-DD)

string

Check-in strictly before datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-in on/before datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-in strictly after datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-in on/after datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

string

Check-in exactly at datetime (listing TZ, YYYY-MM-DDTHH:mm:ss)

Responses

400

Returned when an unsupported filter field, operator, or sort value is provided

500

Indicates server-side error while processing the request

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json