CLcloudbeds
Guest

getGuestsByStatus

Changed on

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

get/getGuestsByStatus

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getGuestsByStatus
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:guest

Query parameters

status'canceled' | 'checked_out' | 'in_house' | 'not_checked_in' required

Guest status during the period

propertyIDstring

ID for the properties to be queried (comma-separated, i.e. 37,345,89).<br /> It can be omitted if the API key is single-property, or to get results from all properties on an association.

resultsFromstring date-time

Used to filter guests result, and returns only the guests that were last modified starting on "resultsFrom" value

resultsTostring date-time

Used to filter guests result, and returns only the guests that were last modified ending on "resultsTo" value

pageNumberinteger

Results page number

pageSizeinteger

Results page size. Max = 100

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results returned

totalinteger

Total number of results

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes