---
updatedAt: 2026-08-20T16:48:56.000Z
agentTools:
  projectIndex: https://docs.ciiruspartners.com/llms.txt
---

# Retrieve units rental

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2024.07.31"
  },
  "paths": {
    "/unit_rental": {
      "get": {
        "summary": "Retrieve units rental",
        "description": "",
        "parameters": [
          {
            "$ref": "#/components/parameters/page_query"
          },
          {
            "$ref": "#/components/parameters/page_size_query"
          },
          {
            "$ref": "#/components/parameters/last_unit_update_date_query"
          },
          {
            "$ref": "#/components/parameters/last_reservation_update_date_query"
          },
          {
            "$ref": "#/components/parameters/last_agent_module_property_update_date_query"
          },
          {
            "$ref": "#/components/parameters/last_agent_module_agent_update_date_query"
          },
          {
            "$ref": "#/components/parameters/unit_id_query"
          },
          {
            "$ref": "#/components/parameters/unit_ids_query"
          },
          {
            "$ref": "#/components/parameters/management_company_user_id_query"
          },
          {
            "$ref": "#/components/parameters/management_company_user_ids_query"
          },
          {
            "$ref": "#/components/parameters/enabled_query"
          },
          {
            "$ref": "#/components/parameters/deleted_query"
          },
          {
            "$ref": "#/components/parameters/display_on_website_query"
          },
          {
            "$ref": "#/components/parameters/allocation_on_arrival_query"
          },
          {
            "$ref": "#/components/parameters/allocation_on_arrival_unit_query"
          },
          {
            "$ref": "#/components/parameters/start_query"
          },
          {
            "$ref": "#/components/parameters/end_query"
          },
          {
            "$ref": "#/components/parameters/maximum_future_days_query"
          },
          {
            "$ref": "#/components/parameters/fallback_rates_query"
          },
          {
            "$ref": "#/components/parameters/channel_query"
          }
        ],
        "responses": {
          "200": {
            "description": "Units rental response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/retrieve_units_rental_response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "tags": [
          "Unit Rental"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2024.07.31"
    }
  ],
  "components": {
    "parameters": {
      "page_query": {
        "name": "page",
        "in": "query",
        "description": "The page to be shown.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "default": 1
        }
      },
      "page_size_query": {
        "name": "page_size",
        "in": "query",
        "description": "Limits the number of returned results.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "default": 25
        }
      },
      "last_unit_update_date_query": {
        "name": "last_unit_update_date",
        "in": "query",
        "description": "Only return units which have been modified after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "last_reservation_update_date_query": {
        "name": "last_reservation_update_date",
        "in": "query",
        "description": "Only return units which have received a booking (their own or a calendar sync) after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "last_agent_module_property_update_date_query": {
        "name": "last_agent_module_property_update_date",
        "in": "query",
        "description": "Only return units which have had their agent module property configuration modified after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "last_agent_module_agent_update_date_query": {
        "name": "last_agent_module_agent_update_date",
        "in": "query",
        "description": "Only return units which have had their agent module agent configuration modified after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "unit_id_query": {
        "name": "unit_id",
        "in": "query",
        "description": "Identifier for unit.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "unit_ids_query": {
        "name": "unit_ids",
        "in": "query",
        "required": false,
        "description": "Identifiers for units.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "management_company_user_id_query": {
        "name": "management_company_user_id",
        "in": "query",
        "description": "Identifier for supplier.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "management_company_user_ids_query": {
        "name": "management_company_user_ids",
        "in": "query",
        "description": "Identifiers for suppliers.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "enabled_query": {
        "name": "enabled",
        "in": "query",
        "description": "Use only enabled or disabled units.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "deleted_query": {
        "name": "deleted",
        "in": "query",
        "description": "Only show properties which are deleted or not deleted.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "display_on_website_query": {
        "name": "display_on_website",
        "in": "query",
        "description": "Only show properties which are enabled for website.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "allocation_on_arrival_query": {
        "name": "allocation_on_arrival",
        "in": "query",
        "description": "Return the allocation on arrival object.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "allocation_on_arrival_unit_query": {
        "name": "allocation_on_arrival_unit",
        "in": "query",
        "description": "Return units which are the representative unit in their group.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "channel_query": {
        "name": "channel",
        "in": "query",
        "description": "Specify channel.",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "all",
            "bdc",
            "vrbo",
            "airbnb"
          ]
        }
      },
      "fallback_rates_query": {
        "name": "fallback_rates",
        "in": "query",
        "description": "Fallback method. Defaults to 'fallback_max_value_rate_plus_guards'.",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "explicitly_in_date_range_only",
            "fallback_max_value_rate",
            "fallback_max_value_rate_plus_guards"
          ]
        }
      },
      "start_query": {
        "name": "start",
        "in": "query",
        "description": "Beginning date for payments to return.",
        "required": true,
        "schema": {
          "type": "string",
          "format": "date"
        }
      },
      "end_query": {
        "name": "end",
        "in": "query",
        "description": "End date for payments to return.",
        "required": true,
        "schema": {
          "type": "string",
          "format": "date"
        }
      },
      "maximum_future_days_query": {
        "name": "maximum_future_days",
        "in": "query",
        "description": "Maximum future days for LOS.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "maximum": 180
        }
      }
    },
    "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"
        ]
      },
      "unit_id": {
        "properties": {
          "unit_id": {
            "type": "integer",
            "format": "int32",
            "description": "Identifier for unit."
          }
        }
      },
      "booking_fence": {
        "properties": {
          "booking_fence": {
            "type": "integer",
            "format": "int32",
            "description": "The minimum number of days between booking and arrival."
          }
        }
      },
      "season_name": {
        "properties": {
          "season_name": {
            "type": "string",
            "format": "int32",
            "description": "Name of the season."
          }
        }
      },
      "gap_days": {
        "properties": {
          "gap_days": {
            "type": "integer",
            "format": "int32",
            "description": "The minimum number of days between departure and arrival."
          }
        }
      },
      "include_mandatory_extras": {
        "properties": {
          "include_mandatory_extras": {
            "type": "boolean",
            "description": "Unit configured to include mandatory extras when quoting/booking."
          }
        }
      },
      "management_company_user_id": {
        "properties": {
          "management_company_user_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique Identifier for supplier"
          }
        }
      },
      "rate_set_id": {
        "properties": {
          "rate_set_id": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "start": {
        "properties": {
          "start": {
            "type": "string",
            "format": "date"
          }
        }
      },
      "end": {
        "properties": {
          "end": {
            "type": "string",
            "format": "date"
          }
        }
      },
      "iso_currency": {
        "properties": {
          "iso_currency": {
            "type": "string"
          }
        }
      },
      "currency_exchanges": {
        "properties": {
          "currency_exchanges": {
            "$ref": "#/components/schemas/currency_exchange"
          }
        }
      },
      "currency_exchange": {
        "properties": {
          "iso_currency": {
            "type": "string"
          },
          "exchange_rate": {
            "type": "number",
            "multipleOf": 0.001
          }
        },
        "required": [
          "iso_currency",
          "exchange_rate"
        ]
      },
      "rates": {
        "properties": {
          "rates": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "length_of_stay_rates": {
        "properties": {
          "length_of_stay_rates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/length_of_stay_rate"
            }
          }
        }
      },
      "length_of_stay_rate": {
        "properties": {
          "date": {
            "type": "string",
            "format": "date"
          },
          "rates": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "length_of_stay_pricing": {
        "properties": {
          "length_of_stay_pricing": {
            "type": "boolean"
          }
        }
      },
      "applicable_taxes": {
        "properties": {
          "applicable_taxes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "tax_one",
                "tax_two",
                "tax_three"
              ]
            }
          }
        }
      },
      "rate_set_details_object": {
        "properties": {
          "rate_set_details": {
            "$ref": "#/components/schemas/rate_set_details"
          }
        }
      },
      "rate_set_details": {
        "allOf": [
          {
            "$ref": "#/components/schemas/agent_daily_markup"
          },
          {
            "$ref": "#/components/schemas/agent_rate_factor"
          },
          {
            "$ref": "#/components/schemas/management_company_rate_factor"
          },
          {
            "$ref": "#/components/schemas/includes_tax"
          },
          {
            "$ref": "#/components/schemas/ciirus_percentage"
          },
          {
            "$ref": "#/components/schemas/include_mandatory_extras"
          },
          {
            "$ref": "#/components/schemas/days_in_month"
          },
          {
            "$ref": "#/components/schemas/allow_length_of_stay"
          }
        ],
        "required": [
          "agent_daily_markup",
          "agent_rate_factor",
          "management_company_rate_factor",
          "includes_tax",
          "ciirus_percentage",
          "include_mandatory_extras",
          "days_in_month",
          "allow_length_of_stay"
        ]
      },
      "agent_daily_markup": {
        "properties": {
          "agent_daily_markup": {
            "type": "number",
            "format": "double",
            "description": "Agent daily markup amount."
          }
        }
      },
      "agent_rate_factor": {
        "properties": {
          "agent_rate_factor": {
            "type": "number",
            "format": "double",
            "description": "Factor applied to agent rates."
          }
        }
      },
      "management_company_rate_factor": {
        "properties": {
          "management_company_rate_factor": {
            "type": "number",
            "format": "double",
            "description": "Factor applied to management company rates."
          }
        }
      },
      "ciirus_percentage": {
        "properties": {
          "ciirus_percentage": {
            "type": "number",
            "format": "double",
            "description": "CiiRUS percentage applied to rates."
          }
        }
      },
      "allow_length_of_stay": {
        "properties": {
          "allow_length_of_stay": {
            "type": "boolean",
            "description": "Indicates if length of stay pricing is allowed."
          }
        }
      },
      "minimum_nights": {
        "properties": {
          "minimum_nights": {
            "type": "integer"
          }
        }
      },
      "maximum_nights": {
        "properties": {
          "maximum_nights": {
            "type": "integer"
          }
        }
      },
      "arrival_days": {
        "properties": {
          "arrival_days": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "departure_days": {
        "properties": {
          "departure_days": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "settings": {
        "properties": {
          "settings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/setting"
            }
          }
        }
      },
      "setting": {
        "allOf": [
          {
            "$ref": "#/components/schemas/booking_fence"
          },
          {
            "$ref": "#/components/schemas/gap_days"
          },
          {
            "$ref": "#/components/schemas/minimum_nights"
          },
          {
            "$ref": "#/components/schemas/maximum_nights"
          },
          {
            "$ref": "#/components/schemas/arrival_days"
          },
          {
            "$ref": "#/components/schemas/departure_days"
          },
          {
            "$ref": "#/components/schemas/season_name"
          }
        ],
        "required": [
          "booking_fence",
          "gap_days",
          "minimum_nights",
          "maximum_nights",
          "arrival_days",
          "departure_days",
          "season_name"
        ]
      },
      "includes_tax": {
        "properties": {
          "includes_tax": {
            "type": "boolean"
          }
        }
      },
      "days_in_month": {
        "properties": {
          "days_in_month": {
            "type": "integer"
          }
        }
      },
      "retrieve_units_rental_response": {
        "properties": {
          "unit_rental": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/unit_rental_response"
            }
          }
        },
        "required": [
          "unit_rental",
          "paging"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/paging_object"
          },
          {
            "type": "object"
          }
        ]
      },
      "error_object": {
        "properties": {
          "error": {
            "$ref": "#/components/schemas/error"
          }
        }
      },
      "error": {
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message."
          }
        }
      },
      "paging_object": {
        "properties": {
          "paging": {
            "$ref": "#/components/schemas/paging"
          }
        },
        "required": [
          "paging"
        ]
      },
      "paging": {
        "properties": {
          "next_page_url": {
            "type": "string",
            "format": "uri",
            "description": "URL to the next page."
          },
          "prev_page_url": {
            "type": "string",
            "format": "uri",
            "description": "URL to the previous page."
          },
          "total_page_count": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Total number of pages available."
          },
          "page": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Current page."
          },
          "page_size": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Current page size."
          }
        }
      },
      "unit_rental_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_id"
          },
          {
            "$ref": "#/components/schemas/management_company_user_id"
          },
          {
            "$ref": "#/components/schemas/rental"
          },
          {
            "$ref": "#/components/schemas/error_object"
          }
        ],
        "required": [
          "unit_id",
          "management_company_user_id",
          "rental"
        ]
      },
      "rental": {
        "properties": {
          "rental": {
            "$ref": "#/components/schemas/rentals"
          }
        }
      },
      "rentals": {
        "allOf": [
          {
            "$ref": "#/components/schemas/rate_set_id"
          },
          {
            "$ref": "#/components/schemas/start"
          },
          {
            "$ref": "#/components/schemas/end"
          },
          {
            "$ref": "#/components/schemas/iso_currency"
          },
          {
            "$ref": "#/components/schemas/currency_exchanges"
          },
          {
            "$ref": "#/components/schemas/rates"
          },
          {
            "$ref": "#/components/schemas/length_of_stay_rates"
          },
          {
            "$ref": "#/components/schemas/length_of_stay_pricing"
          },
          {
            "$ref": "#/components/schemas/settings"
          },
          {
            "$ref": "#/components/schemas/rate_set_details_object"
          },
          {
            "$ref": "#/components/schemas/applicable_taxes"
          }
        ],
        "required": [
          "rate_set_id",
          "start",
          "end",
          "iso_currency",
          "currency_exchanges",
          "length_of_stay_pricing",
          "settings",
          "applicable_taxes",
          "rate_set_details"
        ]
      }
    }
  }
}
```