List reservations

get

https://api.breezeway.io/public/inventory/v1/reservation

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Default Behavior
If no filters are applied or if the filters do not return any results, the endpoint defaults to returning reservations where the checkout_date is greater than or equal to today's date:

checkout_date >= today

Query Params

property_id

array of int32s

Filters reservations by provided Breezeway property IDs

property_id

company_id

array of int32s

Filters reservations by provided Breezeway company IDs (cross-company access required)

company_id

checkin_date_lt

date

Retrieve reservations with a check-in date less than the specified date.

checkin_date_le

date

Retrieve reservations with a check-in date less than or equal to the specified date.

checkin_date_gt

date

Retrieve reservations with a check-in date greater than the specified date.

checkin_date_ge

date

Retrieve reservations with a check-in date greater than or equal to the specified date.

checkout_date_lt

date

Retrieve reservations with a checkout date less than the specified date.

checkout_date_le

date

Retrieve reservations with a checkout date less than or equal to the specified date.

checkout_date_gt

date

Retrieve reservations with a checkout date greater than the specified date.

checkout_date_ge

date

Retrieve reservations with a checkout date greater than or equal to the specified date.

created_at_lt

date

Filter by creation date less than the specified date-time.

created_at_le

date

Filter by creation date less than or equal to the specified date-time.

created_at_gt

date

Filter by creation date greater than the specified date-time.

created_at_ge

date

Filter by creation date greater than or equal to the specified date-time.

updated_at_lt

date

Filter by last updated date less than the specified date-time.

updated_at_le

date

Filter by last updated date less than or equal to the specified date-time.

updated_at_gt

date

Filter by last updated date greater than the specified date-time.

updated_at_ge

date

Filter by last updated date greater than or equal to the specified date-time.

limit

int32

Defaults to 100

Number of records returned per page

page

int32

Defaults to 1

The page to return

sort_by

string

Defaults to created_at

Field to sort results by

sort_order

string

Defaults to desc

Order to sort results in ('asc' or 'desc')

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200