Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Guests

Query for a pageable list of guests.

Either q or created_since_utc is required.

get/v2/guests

Query parameters

qstring nullable

Filter by search query.

created_since_utcstring date-time nullable

Filter by created date (UTC).

fromstring date-time nullable

Filter for guests that depart on or after a specific date (in property timezone).

tostring date-time nullable

Filter for guests that arrive on or before a specific date (in property timezone).

include_tagsboolean

Include tags collection on results.

include_fieldsboolean

Include fields collection on results.

Response

A pageable list of GuestModels representing the matching Guests.

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.