---
title: "getGuestsModified"
method: GET
path: "/getGuestsModified"
tags: ["Guest"]
---

# getGuestsModified

`GET /getGuestsModified`

Returns a list of guests based on their modification date. Note that when a guest checks in or checks out of a room, their record is modified at that time. If no date range is passed, only the records for the current day are returned. Also note that if the guest is assigned to multiple rooms, it will result in multiple records. ### Group account support

## Query parameters

- `propertyIDs` string
- `inHouse` boolean
- `resultsFrom` string, date-time
- `resultsTo` string, date-time
- `checkInFrom` string, date
- `checkInTo` string, date
- `checkOutFrom` string, date
- `checkOutTo` string, date
- `includeGuestRequirements` boolean
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetGuestsModifiedResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Details for the guest linked to the property
    - `guestID` string — Guest ID
    - `reservationID` string — Reservation's unique identifier
    - `roomTypeID` string — Room Type ID that the guest is assigned
    - `roomID` string — Room ID that the guest is assigned
    - `roomName` string — Name of the room where guest is assigned
    - `guestFirstName` string — First Name
    - `guestLastName` string — Last Name
    - `guestGender` 'M' | 'F' | 'N/A'
    - `guestEmail` string — Email Address
    - `guestPhone` string — Phone Number
    - `guestCellPhone` string — Cell Phone Number
    - `guestAddress1` string — Address
    - `guestAddress2` string — Address line 2
    - `guestCity` string — Address city
    - `guestState` string — Address state
    - `guestCountry` string — Address country
    - `guestZip` string — Address zip code
    - `guestBirthDate` string, date — Guests Date of Birth
    - `guestDocumentType` string — Document Type
    - `guestDocumentNumber` string — Document Number
    - `guestDocumentIssueDate` string, date — Document Issue Date
    - `guestDocumentIssuingCountry` string — Document Issuing Country
    - `guestDocumentExpirationDate` string, date — Document Expiration Date
    - `startDate` string, date-time — Check-in date
    - `endDate` string, date-time — Check-out date
    - `guestRequirements` object, nullable — Guest requirements data. Only included if `includeGuestRequirements=true`.
    - `customFields` object[] — List of custom fields
      - `customFieldName` string, nullable — Custom Field Name
      - `customFieldValue` string, nullable — Custom Field Value
    - `dateModified` string, date-time — Guest modification date
    - `taxID` string, nullable — Tax ID
    - `companyTaxID` string, nullable — Company tax ID
    - `companyName` string, nullable — Company name
    - `isAnonymized` boolean — Flag indicating the guest data was removed upon request
    - `guestOptIn` boolean — If guest has opted-in to marketing communication or not
    - `isMerged` boolean — Flag indicating that guest was merged
    - `newGuestID` string — Merged guest ID
  - `count` integer — Number of results returned
  - `total` integer — Total number of results
  - `message` string, nullable — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)