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

# getGuestList

`GET /getGuestList`

Returns a list of guests, ordered by modification date ### Group account support

## Query parameters

- `propertyIDs` string
- `resultsFrom` string, date-time
- `resultsTo` string, date-time
- `checkInFrom` string, date
- `checkInTo` string, date
- `checkOutFrom` string, date
- `checkOutTo` string, date
- `guestFirstName` string
- `guestLastName` string
- `guestEmail` string
- `guestPhone` string
- `guestCellPhone` string
- `status` 'in_progress' | 'confirmed' | 'not_confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show'
- `sortBy` 'creation' | 'modification'
- `includeGuestInfo` boolean
- `excludeSecondaryGuests` boolean
- `includeGuestRequirements` boolean
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetGuestListResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object — Details for the guest linked to the property (key is the 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)