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

# getGuestsByStatus

`GET /getGuestsByStatus`

Returns a list of guests in the current status (Not Checked In, In House, Checked Out or Cancelled), sorted by modification date. If no date range is passed, it returns all guests with the selected status. ### Group account support

## Query parameters

- `status` 'canceled' | 'checked_out' | 'in_house' | 'not_checked_in', required
- `propertyID` string
- `resultsFrom` string, date-time
- `resultsTo` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetGuestsByStatusResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Details for the guest
    - `guestID` string — Guest ID
    - `reservationID` string — Reservation's unique identifier
    - `subReservationID` string
    - `reservationCreatedDateTime` string, date-time — Reservation creation datetime
    - `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' — Gender
    - `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
    - `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
    - `currentStatus` 'canceled' | 'checked_out' | 'in_house' | 'not_checked_in' — Current Status of the guest. Does not need to be equal to the status looked for (it may have had a status change outside of the filtered date range).
    - `statusDate` string, date-time — DateTime when the last status modification occurred.
    - `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
    - `isDeleted` boolean — Flag indicating the guest's reservation was removed
    - `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)