# Retrieve Guest Stays from defined parameters.

Retrieve a paginated list of guest stays within the Property Management System (PMS) based on specified search criteria. This endpoint allows filtering by date range ( and ), unit ID, contact ID, guest details (email, first name, last name), status (, ,  by default), and booking reference. Guest Stays represent individual guest reservations linked to a room stay and include key details such as guest identity, booking status, and associated property information. The response provides a paginated list of Guest Stay records, making it useful for tracking occupancy, managing guest check-ins and check-outs, and retrieving stay details for reporting or operational purposes. If no filters are provided, all guest stays within the default parameters will be returned.

Endpoint: GET /api/v3/guestStays
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `dateFrom` (string)
    Start date of the date range to filter guest stays

  - `dateTo` (string)
    End date of the date range to filter guest stays

  - `unitId` (integer)
    Unique identifier of the unit to filter guest stays

  - `contactId` (integer)
    Unique identifier of the contact to filter guest stays

  - `emailAddress` (string)
    Email address of the guest to filter guest stays

  - `firstName` (string)
    First name of the guest to filter guest stays

  - `lastName` (string)
    Last name of the guest to filter guest stays

  - `statuses` (array)
    Status of the guest stay to filter guest stays (Default to CONFIRMED,CHECKED_IN,CHECKED_OUT if not specified

  - `bookingReference` (string)
    Booking reference of the guest stay to filter guest stays

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (integer)
    The unique identifier of the Guest Stay entity.

  - `content.dateFrom` (string)
    The start date of the Guest Stay.

  - `content.dateTo` (string)
    The end date of the Guest Stay.

  - `content.roomStayId` (integer)
    The unique identifier of the Room Stay entity associated with the Guest Stay.

  - `content.bookingId` (integer)
    The unique identifier of the Booking entity associated with the Guest Stay.

  - `content.contactId` (integer)
    The unique identifier of the Contact associated with the Guest Stay.

  - `content.firstName` (string)
    The first name of the guest.

  - `content.lastName` (string)
    The last name of the guest.

  - `content.status` (string)
    The status of the Guest Stay.

  - `content.unitId` (integer)
    The unique identifier of the Unit associated with the Guest Stay.

  - `content.bookingReference` (string)
    The booking reference associated with the Guest Stay.

  - `content.emailAddress` (string)
    The email address of the guest.

  - `page` (object)

  - `page.size` (integer)

  - `page.totalElements` (integer)

  - `page.totalPages` (integer)

  - `page.number` (integer)