API Reference

getGuestsByStatus

get
https://api.cloudbeds.com/api/v1.3/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 Params
string
enum
required

Guest status during the period

Allowed:
string

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

date-time

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

date-time

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

integer
Defaults to 1

Results page number

integer
Defaults to 20

Results page size. Max = 100

Response

Updated 7 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago