GUguesty
Reservations

Email a reservation list

Changed on

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

Note: This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the Reservations V3 Booking Flow guide for what's available today.

post/reservations.email

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/reservations.email
  • Auth
    API key in header authorization

Query parameters

fieldstring required

Subject of the filter

operatorstring required

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. Required for every operator except $between, which uses from and to instead.

fromstring

Start of the range, inclusive. Used with the $between operator instead of value.

tostring

End of the range, exclusive. Used with the $between operator instead of value.

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",
    "from": "2023-03-02T00:00:00%2B01:00",
    "to": "2023-03-02T23:59:59%2B01:00",
    "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

Changes