API Reference

Retrieve reservations

get
https://api.resly.com.au/reservations
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Scope

This endpoint requires Read Reservations access.

dateType controls how reservations are filtered:

  • Use startDate and endDate (YYYY-MM-DD, max 365 days) when dateType is checkIn or checkOut
  • Use startTime and endTime (UTC, YYYY-MM-DDTHH:mm:ssZ, max 3 days) when dateType is updated
  • The legacy checkIn query parameter filters a single check-in date; prefer dateType=checkIn instead
Query Params
string
enum

How to filter reservations by date. Use checkIn or checkOut with startDate/endDate, or updated with startTime/endTime. Prefer this over the legacy checkIn parameter.

Allowed:
date

Start of the date range (YYYY-MM-DD). Required when dateType is checkIn or checkOut. Range must be 365 days or less.

date

End of the date range (YYYY-MM-DD). Required when dateType is checkIn or checkOut.

date-time

Start of the updated-time range (UTC, YYYY-MM-DDTHH:mm:ssZ). Required when dateType is updated. Range must be 3 days or less.

date-time

End of the updated-time range (UTC, YYYY-MM-DDTHH:mm:ssZ). Required when dateType is updated.

string

Optional filter by reservation status (for example confirmed, cancelled, new). When omitted, all statuses are returned.

string

Optional filter by room ID. Only applied when dateType is checkIn or checkOut.

date
deprecated

Legacy parameter. Filters reservations with this exact check-in date (YYYY-MM-DD). Prefer dateType=checkIn with startDate/endDate instead.

Responses

Updated 21 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago

Did this page help you?