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

# getGuestsByFilter

`GET /getGuestsByFilter`

Returns a list of guests matching the selected parameters ### Group account support

## Query parameters

- `propertyIDs` string
- `status` 'cancelled' | 'checked_out' | 'in_house' | 'not_checked_in', required
- `reservationID` string
- `roomID` string
- `guestName` string
- `checkInFrom` string, date
- `checkInTo` string, date
- `checkOutFrom` string, date
- `checkOutTo` string, date

## Response `200`

200 Response

- GetGuestsByFilterResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Details for the guest
    - `reservationID` string — Reservation's unique identifier
    - `guestName` string
    - `guestID` string — Guest ID
    - `roomID` string — Room ID that the guest is assigned
    - `roomName` string — Name of the room where guest is assigned
    - `isMainGuest` boolean — True if the main guest of the reservation
    - `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)