API Reference

Field Reference

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

count: Total number of reservation objects returned in the data array.

data: Array containing the reservation object(s).


reslyAccountId: Identifier for the Resly account associated with the reservation.

reslyWebhookType: The webhook event type — always "reservation" for reservation triggers.

hotelId: Unique identifier for the hotel or property.

portfolioId: Portfolio ID if the property belongs to a group; empty if not applicable.

reservationId: Internal unique identifier for the reservation.

currency: ISO 4217 currency code used for all monetary values.

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

reservationRef: Public-facing reservation reference number.

checkIn: Scheduled check-in date (YYYY-MM-DD).

checkOut: Scheduled check-out date.

createdOn: Date the reservation was created in the system.

roomId: Identifier for the specific room allocated.

roomName: Display name for the assigned room.

roomTypeId: Identifier for the room type.

roomTypeName: Display name of the room type.

agentId: Identifier for the agent or source channel of the booking.

agentName: Human-readable name of the agent or channel.

ratePlanId: ID of the rate plan applied to the reservation.

ratePlanName: Name of the rate plan (e.g., promotional or standard rate).

bookingDate: The date the reservation was made.

firstName: First name of the guest.

lastName: Last name of the guest.

adults: Number of adults included in the booking.

children: Number of children included.

email: Guest’s email address.

mobile: Guest’s mobile number.

phone: Additional contact phone number, if provided.

company: Company name linked to the reservation, if any.

address: Guest’s address.

city: City in the guest’s address.

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

country: Country of the guest’s address.

postCode: Postcode of the guest’s address.

isCheckedIn: Boolean value indicating if the guest has checked in.

isCheckedOut: Boolean value indicating if the guest has checked out.

arrivalTime: Scheduled or expected time of arrival.

departureTime: Scheduled or expected time of departure.

doNotEmail: Boolean flag indicating whether to exclude the guest from email communications.

depositAmount: Required or collected deposit amount.

depositDueDate: Date the deposit is due.

balanceDueDate: Date the remaining balance is due.

accommodationTotal: Total cost of the accommodation component.

otherTotal: Additional charges (e.g., extras, services).

grandTotal: Total reservation cost including accommodation and extras.

balance: Current balance for the reservation (can be negative for overpayment).

timestampCancelled: ISO timestamp when the reservation was cancelled (or null if not cancelled).

timestampLastModified: ISO timestamp when the reservation was last updated.

roomTypeAddress: Address of the room type or property.

roomTypeCity: City where the room type is located.

roomTypeState: State or region where the room type is located.

roomTypeCountry: Country where the room type is located.

roomTypePostCode: Postcode for the room type location.

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

pinNumber: Optional PIN for access control (e.g., digital locks).

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

id: Duplicate of reservationId, typically included for reference in webhook payloads.