Search Reservations

Search reservations with flexible filtering, sorting and pagination.

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[checkIn][gte]=2026-01-01&filter[checkIn][lt]=2026-02-01 returns reservations checking in during January 2026.

Identifier fields (string equality / set membership)

FieldOperatorsNotes
statuseq, ne, in, ninComma-separated value implies in
listingIdeq, inMatches unitId or unitTypeId on the first stay segment
confirmationCodeeq, inComma-separated value implies in
sourceeq, ine.g. airbnb, booking.com, manual

Date / range fields (operator required)

FieldOperatorsFormat
checkIneq, gte, gt, lte, ltLocalized date YYYY-MM-DD, e.g. 2026-01-15
checkOuteq, gte, gt, lte, ltLocalized date YYYY-MM-DD
createdAteq, gte, gt, lte, ltISO 8601 datetime, e.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 (comma-separated for implicit IN). E.g. airbnb,booking.com

string

Confirmation code (comma-separated for implicit IN)

string

Listing ID (comma-separated for implicit IN). Matches unitId or unitTypeId on first stay.

string

Status not equal to value

string

Status (comma-separated for implicit IN). E.g. confirmed,reserved

string

Reservation created strictly before timestamp (ISO 8601)

string

Reservation created on/after timestamp (ISO 8601)

string

Check-out on/before date

string

Check-out on/after date

string

Check-in strictly before date

string

Check-in on/after date (localized, e.g. 2026-01-01)

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