Skip to main content
POST
Browse bookings
This endpoint sits on the bookings service, so its path starts with /api/bookings-manager/ where the rest of the API starts with /api/guestprofile/. Everything else is unchanged: same token, same entity identifier, same query model. The fields a criterion can target, and the operators each one accepts, are listed on the Search criteria page. Each item pairs the booking with the guest it belongs to. Paginate with limit and offset against the total the response carries, where Browse guests uses an afterKey cursor.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity_id
string<uuid>
required

Body

application/json
limit
integer

Number of items to return in one page.

offset
integer

Number of bookings to skip. Paginate with limit and offset against the total the response returns.

query
object

Response

List of bookings

bookings
object[]
total
integer

Number of bookings matching the query, across every page.