API Reference

List reservations

get
https://api.breezeway.io/public/inventory/v1/reservation/external-id
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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
string
required

Property ID from external system

string

Company ID from external system; required if using cross-company access

string

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

date

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

Response

Updated about 1 year ago

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

Updated about 1 year ago