getGuestsByFilter

Returns guests filtered by reservation status and optional stay/room criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique code of the property (digits only, max 11)

string
required

Reservation status filter (required). Values: Confirmed, Unconfirmed, In-house, Checked-out, Cancelled, No-show, Void

string

Reservation number filter (max 100)

string

Room ID or room name (max 64)

string

Partial guest name match (max 200)

string

Check-in from (YYYY-MM-DD)

string

Check-in to (YYYY-MM-DD)

string

Check-out from (YYYY-MM-DD)

string

Check-out to (YYYY-MM-DD)

integer
≥ 1

Page number (default 1)

integer
1 to 20

Page size (default 20, max 20)

Responses

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json