API Reference

getGuestList

get
https://api.cloudbeds.com/api/v1.3/getGuestList

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

Query Params
string

List of property IDs, comma-separated, i.e. 37,345,89

date-time

Inferior limit datetime, used to filter guests result, based on latest creation/modification date

date-time

Superior limit datetime, used to filter guests result, based on latest creation/modification date

date

Filters guests result to return only guests with check-in date range starting on this date

date

Filters guests result to return only guests with check-in date range ending on this date

date

Filters guests result to return only guests with check-out date range starting on this date

date

Filters guests result to return only guests with check-out date range ending on this date

string

Filters guests result based on Guest First Name

string

Filters guests result based on Guest Last Name

string

Filters guests result based on Guest Email

string

Filters guests result based on Guest Phone Number

string

Filters guests result based on Guest Cell Phone Number

string
enum

Reservation status
If more than one, send as comma-separated values. i.e. in_progress,confirmed

Allowed:
string
enum
Defaults to modification

Sort By parameter

Allowed:
boolean
Defaults to false

If API response should return with more of Guest's information

boolean
Defaults to false

If true, response only returns main guest's

boolean
Defaults to false

Includes guest requirements data in the response

integer
Defaults to 1

Results page number

integer
Defaults to 100

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