--- updatedAt: 2025-09-09T21:11:43.000Z agentTools: projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt --- # Retrieve reservations This method will retrieve all the reservations available to the API user. # OpenAPI definition ```json { "openapi": "3.0.0", "security": [ { "basicAuth": [] } ], "info": { "title": "CiiRUS Partner API", "version": "2023.07.31" }, "paths": { "/reservations": { "get": { "summary": "Retrieve reservations", "description": "This method will retrieve all the reservations available to the API user.", "responses": { "200": { "description": "Reservations response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveReservationsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "parameters": [ { "$ref": "#/components/parameters/noTotal" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/lastUpdateDate" }, { "$ref": "#/components/parameters/mcUserId" }, { "$ref": "#/components/parameters/mcUserIds" }, { "$ref": "#/components/parameters/reference" }, { "$ref": "#/components/parameters/references" }, { "$ref": "#/components/parameters/unitIdQuery" }, { "$ref": "#/components/parameters/unitIdQueries" }, { "$ref": "#/components/parameters/reservationIdQuery" }, { "$ref": "#/components/parameters/reservationIdQueries" }, { "$ref": "#/components/parameters/modifiedStart" }, { "$ref": "#/components/parameters/modifiedEnd" }, { "$ref": "#/components/parameters/arrivalStart" }, { "$ref": "#/components/parameters/arrivalEnd" }, { "$ref": "#/components/parameters/departureStart" }, { "$ref": "#/components/parameters/departureEnd" }, { "$ref": "#/components/parameters/cancelledStart" }, { "$ref": "#/components/parameters/cancelledEnd" }, { "$ref": "#/components/parameters/addedStart" }, { "$ref": "#/components/parameters/addedEnd" }, { "$ref": "#/components/parameters/cancelled" }, { "$ref": "#/components/parameters/quote" }, { "$ref": "#/components/parameters/tentative" }, { "$ref": "#/components/parameters/lynnbrook" }, { "$ref": "#/components/parameters/categoryIds" }, { "$ref": "#/components/parameters/merchantOfRecord" }, { "$ref": "#/components/parameters/addedByStaffId" }, { "$ref": "#/components/parameters/homeAwaySync" } ], "tags": [ "Reservations" ] } } }, "servers": [ { "url": "https://api.ciiruspartners.com/v2023.07.31" } ], "components": { "parameters": { "unitIdQuery": { "name": "unitId", "in": "query", "description": "Unique Identifier for inventory.", "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "unitIdQueries": { "name": "unitIds", "in": "query", "description": "Unique Identifiers for inventory.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "reference": { "name": "reference", "in": "query", "description": "Booking reference.", "schema": { "type": "string" } }, "reservationIdQuery": { "name": "reservationId", "in": "query", "description": "Unique Identifier for reservation.", "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "reservationIdQueries": { "name": "reservationIds", "in": "query", "description": "Unique Identifiers for reservations.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "pageSize": { "name": "pageSize", "in": "query", "description": "Limits the number of returned results.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 25 } }, "noTotal": { "name": "noTotal", "in": "query", "description": "Removes the total page count for faster results.", "required": false, "schema": { "type": "boolean", "default": false } }, "page": { "name": "page", "in": "query", "description": "The page to be shown.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "default": 1 } }, "lastUpdateDate": { "name": "lastUpdateDate", "in": "query", "description": "Only return objects which have been modified after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "modifiedStart": { "name": "modifiedStart", "in": "query", "description": "Only return reservations which have been modified after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "modifiedEnd": { "name": "modifiedEnd", "in": "query", "description": "Only return reservations which have been modified before a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "arrivalStart": { "name": "arrivalStart", "in": "query", "description": "Only return reservations which arrive after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "arrivalEnd": { "name": "arrivalEnd", "in": "query", "description": "Only return reservations which arrive before a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "departureStart": { "name": "departureStart", "in": "query", "description": "Only return reservations which depart after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "departureEnd": { "name": "departureEnd", "in": "query", "description": "Only return reservations which depart before a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "cancelledStart": { "name": "cancelledStart", "in": "query", "description": "Only return reservations which have been cancelled after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "cancelledEnd": { "name": "cancelledEnd", "in": "query", "description": "Only return reservations which have been cancelled before a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "addedStart": { "name": "addedStart", "in": "query", "description": "Only return reservations which have been added after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "addedEnd": { "name": "addedEnd", "in": "query", "description": "Only return reservations which have been added before a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "cancelled": { "name": "cancelled", "in": "query", "description": "Only return reservations which have been cancelled.", "required": false, "schema": { "type": "boolean" } }, "quote": { "name": "quote", "in": "query", "description": "Only return reservations which are quotes.", "required": false, "schema": { "type": "boolean" } }, "tentative": { "name": "tentative", "in": "query", "description": "Only return reservations which are tentative.", "required": false, "schema": { "type": "boolean" } }, "lynnbrook": { "name": "lynnbrook", "in": "query", "description": "Only returns specific properties for lynnbrook.", "required": false, "schema": { "type": "boolean" } }, "mcUserId": { "name": "mcUserId", "in": "query", "description": "Unique Identifier for supplier.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "merchantOfRecord": { "name": "merchantOfRecord", "in": "query", "description": "Filter by merchant of record.", "required": false, "schema": { "type": "integer", "format": "int32" } }, "addedByStaffId": { "name": "addedByStaffId", "in": "query", "description": "Unique Identifier for user who added reservation.", "required": false, "schema": { "type": "integer", "format": "int32" } }, "homeAwaySync": { "name": "homeAwaySync", "in": "query", "description": "Filter home away sync properties reservations.", "required": false, "schema": { "type": "boolean" } }, "mcUserIds": { "name": "mcUserIds", "in": "query", "description": "Unique Identifiers for suppliers.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "categoryIds": { "name": "categoryIds", "in": "query", "description": "Unique Identifiers for categories.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "references": { "name": "references", "description": "Booking references.", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } } }, "responses": { "BadRequest": { "description": "Bad Request response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Unauthorized response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Forbidden response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Not Found response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "PagedLambdaResponseObject": { "properties": { "next_page_url": { "type": "string", "format": "uri", "description": "URL to the next page (not present on last page)" }, "previous_page_url": { "type": "string", "format": "uri", "description": "URL to the previous page (not present on first page)" }, "total_page_count": { "type": "integer", "format": "int32", "minimum": 0, "description": "Total number of pages available" } }, "required": [ "total_page_count" ] }, "address_line_1": { "properties": { "address_line_1": { "type": "string" } } }, "address_line_2": { "properties": { "address_line_2": { "type": "string" } } }, "city": { "properties": { "city": { "type": "string" } } }, "state_province": { "properties": { "state_province": { "type": "string" } } }, "country": { "properties": { "country": { "type": "string" } } }, "postal_code": { "properties": { "postal_code": { "type": "string" } } }, "email": { "properties": { "email": { "type": "string" } } }, "first_name": { "properties": { "first_name": { "type": "string" } } }, "last_name": { "properties": { "last_name": { "type": "string" } } }, "address": { "allOf": [ { "$ref": "#/components/schemas/address_line_1" }, { "$ref": "#/components/schemas/address_line_2" }, { "$ref": "#/components/schemas/city" }, { "$ref": "#/components/schemas/state_province" }, { "$ref": "#/components/schemas/country" }, { "$ref": "#/components/schemas/postal_code" } ] }, "RetrieveReservationsResponse": { "properties": { "reservations": { "type": "array", "items": { "$ref": "#/components/schemas/reservation" } } }, "required": [ "reservations" ], "allOf": [ { "$ref": "#/components/schemas/PagedLambdaResponseObject" }, { "type": "object" } ] }, "reservation": { "required": [ "arrival" ], "allOf": [ { "$ref": "#/components/schemas/booking_id" }, { "$ref": "#/components/schemas/arrival" }, { "$ref": "#/components/schemas/departure" }, { "$ref": "#/components/schemas/added" }, { "$ref": "#/components/schemas/reference" }, { "$ref": "#/components/schemas/last_modified" }, { "$ref": "#/components/schemas/status" }, { "$ref": "#/components/schemas/expiration" }, { "$ref": "#/components/schemas/cancelled_on" }, { "$ref": "#/components/schemas/unit_id" }, { "$ref": "#/components/schemas/clone_id" }, { "$ref": "#/components/schemas/clone_user_id" }, { "$ref": "#/components/schemas/merchant_of_record_alt" }, { "$ref": "#/components/schemas/owner_reservation" }, { "$ref": "#/components/schemas/payments" }, { "$ref": "#/components/schemas/payment_schedule" }, { "$ref": "#/components/schemas/comments" }, { "$ref": "#/components/schemas/total" }, { "$ref": "#/components/schemas/total_paid" }, { "$ref": "#/components/schemas/amount_decimal_places" }, { "$ref": "#/components/schemas/financials" }, { "$ref": "#/components/schemas/arrival_departure_info" }, { "$ref": "#/components/schemas/secure_details" }, { "$ref": "#/components/schemas/category" }, { "$ref": "#/components/schemas/category_id" }, { "$ref": "#/components/schemas/scenario" }, { "$ref": "#/components/schemas/agent_id" }, { "$ref": "#/components/schemas/adults" }, { "$ref": "#/components/schemas/children" }, { "$ref": "#/components/schemas/lead_guest_details" }, { "$ref": "#/components/schemas/guest_list" }, { "$ref": "#/components/schemas/early_check_in" }, { "$ref": "#/components/schemas/late_check_out" } ] }, "booking_id": { "properties": { "id": { "type": "integer" } } }, "added": { "properties": { "added": { "type": "string", "format": "date-time" } } }, "reference": { "properties": { "reference": { "type": "string" } } }, "last_modified": { "properties": { "last_modified": { "type": "string", "format": "date-time" } } }, "expiration": { "properties": { "expiration": { "type": "string", "format": "date-time" } } }, "cancelled_on": { "properties": { "cancelled_on": { "type": "string", "format": "date-time" } } }, "merchant_of_record_alt": { "properties": { "merchant_of_record": { "type": "integer" } } }, "clone_id": { "properties": { "clone_id": { "type": "integer" } } }, "clone_user_id": { "properties": { "clone_user_id": { "type": "integer" } } }, "status": { "properties": { "status": { "type": "string", "enum": [ "CONFIRMED", "CANCELLED", "TENTATIVE" ] } } }, "owner_reservation": { "properties": { "owner_reservation": { "type": "boolean" } } }, "payment_item": { "allOf": [ { "$ref": "#/components/schemas/amount" }, { "$ref": "#/components/schemas/amount_decimal_places" }, { "$ref": "#/components/schemas/payment_date" } ] }, "payments": { "properties": { "payments": { "type": "array", "items": { "$ref": "#/components/schemas/payment_item" } } } }, "payment_schedule_item": { "allOf": [ { "$ref": "#/components/schemas/amount" }, { "$ref": "#/components/schemas/amount_decimal_places" }, { "$ref": "#/components/schemas/due_date" } ] }, "payment_date": { "properties": { "payment_date": { "type": "string", "format": "date-time" } } }, "due_date": { "properties": { "due_date": { "type": "string", "format": "date-time" } } }, "payment_schedule": { "properties": { "payment_schedule": { "type": "array", "items": { "$ref": "#/components/schemas/payment_schedule_item" } } } }, "comments": { "properties": { "comments": { "type": "string" } } }, "total": { "properties": { "total": { "type": "integer", "format": "int64", "description": "The total value of this booking." } } }, "total_paid": { "properties": { "total_paid": { "type": "integer", "format": "int64", "description": "The total amount paid by the customer." } } }, "amount_decimal_places": { "properties": { "amount_decimal_places": { "type": "integer", "default": 2, "minimum": 1, "description": "The number of decimal places to represent the amount as." } } }, "financials": { "properties": { "financials": { "type": "array", "items": { "$ref": "#/components/schemas/charge" } } }, "allOf": [ { "$ref": "#/components/schemas/total_amount" }, { "$ref": "#/components/schemas/amount_decimal_places" } ] }, "charge": { "properties": { "item": { "type": "string" }, "id": { "type": "string" }, "code": { "type": "string" }, "applies_to_id": { "type": "string" }, "quantity": { "type": "integer" } }, "allOf": [ { "$ref": "#/components/schemas/charge_type" }, { "$ref": "#/components/schemas/amount" }, { "$ref": "#/components/schemas/amount_decimal_places" } ] }, "arrival_departure_info": { "properties": { "arrival_departure_info": { "type": "string" } } }, "secure_details": { "properties": { "secure_details": { "$ref": "#/components/schemas/secure_detail" } } }, "secure_detail": { "allOf": [ { "$ref": "#/components/schemas/lock_box_code" }, { "$ref": "#/components/schemas/gate_code" }, { "$ref": "#/components/schemas/alarm_code" }, { "$ref": "#/components/schemas/wifi_ssid" }, { "$ref": "#/components/schemas/wifi_password" }, { "$ref": "#/components/schemas/lobby_code" }, { "$ref": "#/components/schemas/fitness_room_code" }, { "$ref": "#/components/schemas/pool_access_code" }, { "$ref": "#/components/schemas/beach_access_code" } ] }, "lock_box_code": { "properties": { "lock_box_code": { "type": "string" } } }, "gate_code": { "properties": { "gate_code": { "type": "string" } } }, "alarm_code": { "properties": { "alarm_code": { "type": "string" } } }, "wifi_ssid": { "properties": { "wifi_ssid": { "type": "string" } } }, "wifi_password": { "properties": { "wifi_password": { "type": "string" } } }, "lobby_code": { "properties": { "lobby_code": { "type": "string" } } }, "fitness_room_code": { "properties": { "fitness_room_code": { "type": "string" } } }, "pool_access_code": { "properties": { "pool_access_code": { "type": "string" } } }, "beach_access_code": { "properties": { "beach_access_code": { "type": "string" } } }, "category_id": { "properties": { "category_id": { "type": "integer" } } }, "category": { "properties": { "category": { "type": "string" } } }, "scenario": { "properties": { "scenario": { "type": "integer" } } }, "agent_id": { "properties": { "agent_id": { "type": "integer" } } }, "adults": { "properties": { "adults": { "type": "integer" } } }, "children": { "properties": { "children": { "type": "integer" } } }, "lead_guest_details": { "properties": { "lead_guest_details": { "$ref": "#/components/schemas/guest" } } }, "guest_list": { "properties": { "guest_list": { "type": "array", "items": { "$ref": "#/components/schemas/guest" } } } }, "early_check_in": { "properties": { "early_check_in": { "type": "boolean" } } }, "late_check_out": { "properties": { "late_check_out": { "type": "boolean" } } }, "guest": { "allOf": [ { "$ref": "#/components/schemas/name" }, { "$ref": "#/components/schemas/age" }, { "$ref": "#/components/schemas/first_name" }, { "$ref": "#/components/schemas/last_name" }, { "$ref": "#/components/schemas/phone" }, { "$ref": "#/components/schemas/email" }, { "$ref": "#/components/schemas/guestAddress" } ] }, "guestAddress": { "properties": { "address": { "$ref": "#/components/schemas/address" } } }, "age": { "properties": { "age": { "type": "integer" } } }, "phone": { "properties": { "phone": { "type": "string" } } }, "arrival": { "properties": { "arrival": { "type": "string", "format": "date-time" } } }, "departure": { "properties": { "departure": { "type": "string", "format": "date-time" } } }, "amount": { "properties": { "amount": { "type": "integer" } } }, "total_amount": { "properties": { "total_amount": { "type": "integer" } } }, "unit_id": { "properties": { "unit_id": { "type": "integer", "format": "int32", "description": "Unique identifier for inventory" } } }, "name": { "properties": { "name": { "type": "string" } } }, "charge_type": { "properties": { "type": { "type": "string", "enum": [ "TAX_ONE,", "TAX_TWO,", "TAX_THREE", "EXTRA,", "BOOKING_FEE,", "CLEAN_FEE", "RENTAL,", "STANDARD_DISCOUNT,", "POOL_HEAT_FEE" ] } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```