Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations

Send results in email

Use this request to export a custom list of reservations in an Email. Results are limited to 250 reservations per a request.

post/reservations.email

Query parameters

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: checkIn

limitinteger

Limit for list of records. Default value: 250, max: 500

skipinteger

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

Request body

tostring required

Address of recipient

Example request

{
  "to": "koby@guesty.com"
}

Response

Array of reservations objects