v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Reservations

Search reservations

Retrieve all reservations or a filtered subset of them.

get/reservations

Query parameters

viewIdstring

View Id

fieldstring

Subject of the filter

operatorstring

Enhanced MongoDB comparison operator: $eq, $not, $contains, $notcontains, $gt, $lt, $between

IMPORTANT NOTE: In order to use the $between operator please check the syntax of the example below: [{"field":"checkIn", "operator":"$between","from":"2023-03-02T00:00:00%2B01:00","to":"2023-03-02T23:59:59%2B01:00"}]

valuestring

Value to filter by

contextstring

Optional preprocessing. Options are now, createdAt, confirmedAt, canceledAt, alteredAt. When given, the date in value is relative to the context.

Array of filters to query by

[
  {
    "field": "checkIn",
    "operator": "$gt",
    "value": "2025-09-10T12:49:44.616Z",
    "context": "now"
  }
]

fieldsstring

Selection of fields, separated by space

sortstring

Sorting, default: _id

limitinteger

Limit for list of records. Default value: 25, max: 100

skipinteger

Skip number of records. In case nothing provided so nothing will be skipped

Response

Reservation object

flagboolean

accountingEnabledboolean

isBMAppliedboolean

pulledByDailySyncboolean

manuallyCreatedboolean

_idstring

Unique Id

statusstring

checkInstring

checkOutstring

nightsCountnumber

guestsCountnumber

listingIdstring

Unique Id

checkInDateLocalizedstring

checkOutDateLocalizedstring

accountIdstring

Unique Id

guestIdstring

Unique Id

sourcestring

secondarySourcestring

Reservation website name. Should be present in case 'source' is one of ['BE-API', 'Booking Engine', 'website']. If absent, it means we failed to extract the secondary source information.

confirmationCodestring

isReturningGuestboolean

confirmedAtstring

importedAtstring

createdAtstring

lastUpdatedAtstring

__vnumber

conversationIdstring

Unique Id

idstring

Unique Id

isMidStayboolean

lastStayListingIdstring

Unique Id

Example response

{
  "integration": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "atTimeOfConfirmation": {
    "channelCommission": {
      "_id": "563e0b6a08a2710e00057b82"
    },
    "taxes": [
      {
        "_id": "563e0b6a08a2710e00057b82"
      }
    ]
  },
  "_id": "563e0b6a08a2710e00057b82",
  "checkIn": "2021-08-17T07:00:00.000Z",
  "checkOut": "2021-08-17T07:00:00.000Z",
  "money": {
    "invoiceItems": [
      {
        "_id": "563e0b6a08a2710e00057b82"
      }
    ],
    "payments": [
      {
        "authenticationRequiredData": {
          "lastAuthMsgSentDate": "2021-08-16T08:38:20.280Z"
        },
        "createdAt": "2021-08-16T08:38:20.280Z",
        "attempts": [
          {
            "createdAt": "2021-08-16T08:38:20.280Z",
            "_id": "563e0b6a08a2710e00057b82",
            "payload": {
              "payment_intent": {
                "id": "563e0b6a08a2710e00057b82",
                "charges": {
                  "data": [
                    {
                      "metadata": {
                        "accountId": "563e0b6a08a2710e00057b82",
                        "reservationId": "563e0b6a08a2710e00057b82",
                        "listingId": "563e0b6a08a2710e00057b82"
                      }
                    }
                  ]
                },
                "metadata": {
                  "accountId": "563e0b6a08a2710e00057b82",
                  "reservationId": "563e0b6a08a2710e00057b82",
                  "listingId": "563e0b6a08a2710e00057b82"
                }
              }
            }
          }
        ],
        "_id": "563e0b6a08a2710e00057b82",
        "shouldBePaidAt": "2021-08-16T08:38:20.280Z",
        "paymentMethodId": "563e0b6a08a2710e00057b82",
        "guestId": "563e0b6a08a2710e00057b82"
      }
    ]
  },
  "listingId": "563e0b6a08a2710e00057b82",
  "accountId": "563e0b6a08a2710e00057b82",
  "guestId": "563e0b6a08a2710e00057b82",
  "mtl": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "confirmedAt": "2021-08-17T07:00:00.000Z",
  "importedAt": "2021-08-17T07:00:00.000Z",
  "additionalFeesAtCreation": [
    {
      "_id": "563e0b6a08a2710e00057b82",
      "accountId": "563e0b6a08a2710e00057b82"
    }
  ],
  "createdAt": "2021-08-17T07:00:00.000Z",
  "lastUpdatedAt": "2021-08-17T07:00:00.000Z",
  "conversationId": "563e0b6a08a2710e00057b82",
  "id": "563e0b6a08a2710e00057b82",
  "lastStayListingId": "563e0b6a08a2710e00057b82",
  "stay": {
    "id": "563e0b6a08a2710e00057b82",
    "unitTypeId": "563e0b6a08a2710e00057b82",
    "unitId": "563e0b6a08a2710e00057b82"
  }
}