Sign in

7c62644070f2

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Open Api [Beta]

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.

get/reservations-v3/search

Query parameters

skipnumber

Number of records to skip

limitnumber
Example:50

Maximum records to return

sort'_id' | '-_id' | 'checkIn' | '-checkIn' | 'checkOut' | '-checkOut' | 'createdAt' | '-createdAt'
Example:-checkIn

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

filter[source]string
Example:airbnb,booking.com

Reservation source (comma-separated for implicit IN). E.g. airbnb,booking.com

filter[confirmationCode]string
Example:ABC123

Confirmation code (comma-separated for implicit IN)

filter[listingId]string
Example:6213b03e7f0ba50032296f4a

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

filter[status][ne]string
Example:canceled

Status not equal to value

filter[status]string
Example:confirmed,reserved

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

filter[createdAt][lt]string
Example:2026-02-01T00:00:00Z

Reservation created strictly before timestamp (ISO 8601)

filter[createdAt][gte]string
Example:2026-01-01T00:00:00Z

Reservation created on/after timestamp (ISO 8601)

filter[checkOut][lte]string
Example:2026-03-01

Check-out on/before date

filter[checkOut][gte]string
Example:2026-01-15

Check-out on/after date

filter[checkIn][lt]string
Example:2026-02-01

Check-in strictly before date

filter[checkIn][gte]string
Example:2026-01-01

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

Response

Success

Example response

{
  "results": [
    {
      "reservationId": "65aff36cbf774b59c718a0c7",
      "confirmationCode": "ABC123",
      "status": "confirmed",
      "guestId": "65aff36cbf774b59c718a0c7",
      "checkIn": "2026-01-15T14:00:00.000Z",
      "checkOut": "2026-01-20T11:00:00.000Z",
      "checkInDateLocalized": "2026-01-15",
      "checkOutDateLocalized": "2026-01-20",
      "source": "manual",
      "channel": "manual",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "bookingDate": "2026-01-01T00:00:00.000Z",
      "reservedExpiresAt": "2026-01-02T00:00:00.000Z",
      "groupId": "65aff36cbf774b59c718a0c7",
      "sendQuoteId": "65aff36cbf774b59c718a0c7",
      "pointOfSale": "Booking Engine",
      "uploadedAt": "2026-01-01T00:00:00.000Z",
      "unifiedId": "unified-id-example",
      "stay": [
        {
          "listingId": "65aff36cbf774b59c718a0c7",
          "parentListingId": "65aff36cbf774b59c718a0c7",
          "ratePlanId": "653d068c5a241a00394a539d",
          "checkIn": "2026-01-15T14:00:00.000Z",
          "checkOut": "2026-01-20T11:00:00.000Z",
          "checkInDateLocalized": "2026-01-15",
          "checkOutDateLocalized": "2026-01-20",
          "guestsCount": 2,
          "numberOfGuests": {
            "numberOfChildren": 1,
            "numberOfInfants": 1,
            "numberOfPets": 1,
            "numberOfAdults": 1
          }
        }
      ]
    }
  ],
  "pagination": {
    "limit": 25
  }
}