Retrieve reservations

get

https://api.ciiruspartners.com/v2023.07.31/reservations

This method will retrieve all the reservations available to the API user.

Query Params

noTotal

boolean

Defaults to false

Removes the total page count for faster results.

page

int32

≥ 1

Defaults to 1

The page to be shown.

pageSize

int32

1 to 1000

Defaults to 25

Limits the number of returned results.

lastUpdateDate

date-time

Only return objects which have been modified after a certain date.

mcUserId

int32

≥ 0

Unique Identifier for supplier.

mcUserIds

array of int32s

Unique Identifiers for suppliers.

mcUserIds

reference

string

Booking reference.

references

array of strings

Booking references.

references

unitId

int32

≥ 0

Unique Identifier for inventory.

unitIds

array of int32s

Unique Identifiers for inventory.

unitIds

reservationId

int32

≥ 0

Unique Identifier for reservation.

reservationIds

array of int32s

Unique Identifiers for reservations.

reservationIds

modifiedStart

date-time

Only return reservations which have been modified after a certain date.

modifiedEnd

date-time

Only return reservations which have been modified before a certain date.

arrivalStart

date-time

Only return reservations which arrive after a certain date.

arrivalEnd

date-time

Only return reservations which arrive before a certain date.

departureStart

date-time

Only return reservations which depart after a certain date.

departureEnd

date-time

Only return reservations which depart before a certain date.

cancelledStart

date-time

Only return reservations which have been cancelled after a certain date.

cancelledEnd

date-time

Only return reservations which have been cancelled before a certain date.

addedStart

date-time

Only return reservations which have been added after a certain date.

addedEnd

date-time

Only return reservations which have been added before a certain date.

cancelled

boolean

Only return reservations which have been cancelled.

quote

boolean

Only return reservations which are quotes.

tentative

boolean

Only return reservations which are tentative.

lynnbrook

boolean

Only returns specific properties for lynnbrook.

categoryIds

array of int32s

Unique Identifiers for categories.

categoryIds

merchantOfRecord

int32

Filter by merchant of record.

addedByStaffId

int32

Unique Identifier for user who added reservation.

homeAwaySync

boolean

Filter home away sync properties reservations.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Reservations response

400Bad Request response

401Unauthorized response

403Forbidden response

404Not Found response