API Reference

Field Reference

type: The type of object returned by the API, always "reservations" for this endpoint.

data: The reservation details object.


reslyAccountId: Identifier for the Resly account managing the reservation.

reslyWebhookType: Indicates the webhook type; "reservation" for reservation-related events.

hotelId: Unique identifier for the hotel or property.

portfolioId: ID for the portfolio or group the property belongs to.

currency: Currency code (ISO 4217 format) for monetary values.

status: Reservation status (e.g., confirmed, cancelled, pending, waitlist)

reservationRef: Public-facing reservation reference number.

checkIn: Scheduled check-in date.

checkOut: Scheduled check-out date.

createdOn: Date the reservation was created.

roomId: Unique identifier for the assigned room.

roomName: Display name or label for the room.

roomTypeId: Identifier for the room type category.

roomTypeName: Display name of the room type.

agentId: Unique identifier for the booking source or agent.

agentName: Display name of the booking agent or channel.

agentReference: Reference number or code provided by the agent.

ratePlanId: ID for the rate plan associated with the booking.

ratePlanName: Display name of the rate plan.

bookingDate: Date the booking was originally made.

comments: Additional comments or notes added to the reservation.

firstName: Guest’s first name.

lastName: Guest’s last name.

adults: Number of adults on the reservation.

children: Number of children on the reservation.

email: Email address of the guest.

mobile: Mobile phone number of the guest.

phone: Additional contact phone number.

company: Company name associated with the booking, if any.

address: Address of the guest.

city: City of the guest’s address.

state: State or region of the guest’s address.

country: Country of the guest’s address.

postCode: Postcode or ZIP of the guest’s address.

isCheckedIn: Boolean indicating if the guest has checked in.

isCheckedOut: Boolean indicating if the guest has checked out.

arrivalTime: Expected arrival time window.

departureTime: Expected departure time window.

doNotEmail: Boolean indicating if guest has opted out of emails.

depositAmount: Total deposit required or paid.

depositDueDate: Due date for the deposit.

balanceDueDate: Due date for the balance payment.

accommodationTotal: Cost of accommodation only.

otherTotal: Cost of other charges (e.g., extras, fees).

grandTotal: Total reservation amount including all charges.

balance: Remaining balance on the reservation (can be negative if overpaid).

timestampCancelled: Timestamp when the reservation was cancelled (if applicable).

timestampLastModified: Timestamp of the last update to the reservation.

roomNotes: Internal notes or instructions specific to the room or stay.

roomTypeDescription: Full description of the room type and its features.

roomTypeAddress: Physical address of the room or property.

roomTypeCity: City where the room or property is located.

roomTypeState: State or region of the room or property.

roomTypeCountry: Country of the room or property.

roomTypePostCode: Postcode of the room or property.

userCreated: Name of the Resly user or staff member who created the reservation.

pinNumber: PIN associated with the reservation (for access control, if used).

pinStatus: Status of the PIN (e.g., active, expired, or empty if unused).