API Reference
  1. Yanolja Cloud Solution API
  2. Guest

getGuestList

get
https://api.yanoljacloudsolution.com/api/v1/getGuestList

Returns a filtered, paginated list of guests. Supports comma-separated hotelCode for multi-property.

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

Property code(s). Comma-separated for multi-property (max 25 properties; each digits-only, max 11).

string

Created/modified from (ISO-8601 datetime)

string

Created/modified to (ISO-8601 datetime)

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)

string

Partial guest name match (max 256)

string

Partial first name match (max 256)

string

Partial last name match (max 256)

string

Guest email filter

string

Guest phone filter

string

Guest mobile phone filter

string

Reservation status filter. Comma-separated allowed. Values: Confirmed, Unconfirmed, In-house, Checked-out, Cancelled, No-show, Void

string

Sort key: 'creation' or 'modification' (default modification)

boolean

When true, returns primary guests only. Defaults to false.

boolean

When true, includes guest requirements. Defaults to false.

integer
≥ 1

Page number (default 1)

integer
1 to 20

Page size (default 20, max 20)

Responses

Updated about 2 months ago

Did this page help you?
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

Updated about 2 months ago

Did this page help you?