List reservations

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

Use this endpoint to retrieve the reservations that match your query parameters.

Before you call this endpoint

  1. Include an access token with either the reservations.read or reservations.manage scope.
  2. Add query parameters when you want to filter the result set.
  3. Use the expand parameter when you want the response to include embedded resources.

What this endpoint does

The API returns the reservations that match the filters you send with the request. If you do not send any filters, the API returns all reservations.

Authorization

Send an access token that includes at least one of these scopes:

  • reservations.read
  • reservations.manage
Query Params
string
propertyIds
array of strings
propertyIds
ratePlanIds
array of strings
ratePlanIds
companyIds
array of strings
companyIds
unitIds
array of strings
unitIds
unitGroupIds
array of strings
unitGroupIds
unitGroupTypes
array of strings
unitGroupTypes
blockIds
array of strings
blockIds
marketSegmentIds
array of strings
marketSegmentIds
status
array of strings
status
string
enum
date-time
date-time
channelCode
array of strings
channelCode
sources
array of strings
sources
validationMessageCategory
array of strings
validationMessageCategory
string
string
balanceFilter
array of strings
balanceFilter
boolean
boolean
externalReferences
array of strings
externalReferences
integer
Defaults to 1
integer
Defaults to 500
sort
array of strings
sort
expand
array of strings
expand
Responses

204

No reservations found.

400

Bad request.

401

You are unauthorized.

403

Forbidden.

404

The Request-URI could not be found.

499

Client closed request.

500

An unexpected error occurred.

503

The server is currently unavailable. Please try later.

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