API Reference

Field Reference

type: The type of response object; always "reservations" for this endpoint.

count: The number of reservation records returned in the data array.

data: An array containing reservation object(s).


hotelId: Unique identifier for the hotel or property.

portfolioId: Identifier for the group or portfolio the room type belongs to (empty if not applicable).

reservationId: Unique ID of the reservation.

currency: ISO 4217 code for the currency used (e.g., AUD).

status: Current status of the reservation (e.g., confirmed, cancelled). confirmed pending cancelled waitlist

reservationRef: Public-facing reference number for the reservation.

checkIn: Scheduled check-in date in YYYY-MM-DD format.

checkOut: Scheduled check-out date.

createdOn: The date the reservation was created.

roomId: Identifier for the specific room allocated to the reservation.

roomName: Display name of the allocated room (e.g., “Unit 202”).

roomTypeId: Identifier for the room type.

roomTypeName: Display name of the room type.

agentId: Identifier for the booking agent or channel (e.g., DIRECT).

agentName: Human-readable name of the agent or booking source.

agentReference: Optional reference number from the agent or OTA; blank if not provided while creating a reservation through the PMS.

ratePlanId: Identifier for the pricing or rate plan applied to the booking.

ratePlanName: Name of the rate plan (e.g., “7-N-LAVISH-1”).

bookingDate: The date the guest made the booking.

firstName: Guest’s first name.

lastName: Guest’s last name.

adults: Number of adults included in the reservation.

children: Number of children included.

email: Guest’s email address.

mobile: Guest’s mobile number.

phone: Alternative or landline phone number.

address: Guest’s address.

country: Country of the guest’s address.

postCode: Postcode for the guest’s address.

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

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

arrivalTime: Expected arrival time; can be empty if not set.

departureTime: Expected departure time; can be empty if not set.

doNotEmail: Boolean flag indicating whether the guest should be excluded from automated/resly marketing emails.

depositAmount: Deposit amount charged or expected.

depositDueDate: The date the deposit is/was due.

balanceDueDate: The date the balance is/was due.

accommodationTotal: Total cost of the accommodation.

otherTotal: Total cost of any additional charges (e.g., extras, fees); 0 if none.

grandTotal: Sum of accommodation and other totals.

balance: Outstanding balance on the booking; can be negative to indicate overpayment or refund due.

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

timestampLastModified: Timestamp for the most recent update to the reservation.

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

pinNumber: Optional PIN code for secure access (e.g., smart lock or kiosk check-in).

pinStatus: Status of the PIN (e.g., active, expired, or blank if not in use).