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

# Retrieve unit calendar

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2024.07.31"
  },
  "paths": {
    "/unit_calendars/{unit_id}": {
      "get": {
        "summary": "Retrieve unit calendar",
        "description": "",
        "parameters": [
          {
            "$ref": "#/components/parameters/unit_id_path"
          },
          {
            "$ref": "#/components/parameters/start_query"
          },
          {
            "$ref": "#/components/parameters/end_query"
          },
          {
            "$ref": "#/components/parameters/reservation_id_query"
          },
          {
            "$ref": "#/components/parameters/allocated_reservations_query"
          },
          {
            "$ref": "#/components/parameters/category_to_ignore_query"
          },
          {
            "$ref": "#/components/parameters/fallback_rates_query"
          },
          {
            "$ref": "#/components/parameters/channel_query"
          }
        ],
        "responses": {
          "200": {
            "description": "Unit calendar response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/retrieve_unit_calendar_response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "tags": [
          "Unit Calendars"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2024.07.31"
    }
  ],
  "components": {
    "parameters": {
      "unit_id_path": {
        "name": "unit_id",
        "in": "path",
        "description": "Unique Identifier for inventory.",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      },
      "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"
        }
      },
      "reservation_id_query": {
        "name": "reservation_id",
        "in": "query",
        "description": "Unique Identifier for booking.",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "allocated_reservations_query": {
        "name": "allocated_reservations",
        "in": "query",
        "description": "Unallocated reservations that you would like to virtually allocate.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "category_to_ignore_query": {
        "name": "category_to_ignore",
        "in": "query",
        "description": "Booking category to ignore.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "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."
          }
        }
      },
      "management_company_user_id": {
        "properties": {
          "management_company_user_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique Identifier for supplier"
          }
        }
      },
      "retrieve_unit_calendar_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_calendar_response"
          },
          {
            "type": "object"
          }
        ]
      },
      "error_object": {
        "properties": {
          "error": {
            "$ref": "#/components/schemas/error"
          }
        }
      },
      "error": {
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message."
          }
        }
      },
      "unit_calendar_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_id"
          },
          {
            "$ref": "#/components/schemas/management_company_user_id"
          },
          {
            "$ref": "#/components/schemas/start_date"
          },
          {
            "$ref": "#/components/schemas/end_date"
          },
          {
            "$ref": "#/components/schemas/calendar_days"
          },
          {
            "$ref": "#/components/schemas/calendar_allocation_on_arrival"
          },
          {
            "$ref": "#/components/schemas/error_object"
          }
        ],
        "required": [
          "unit_id",
          "management_company_user_id",
          "start_date",
          "end_date",
          "days"
        ]
      },
      "start_date": {
        "properties": {
          "start_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "end_date": {
        "properties": {
          "end_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "calendar_allocation_on_arrival": {
        "properties": {
          "allocation_on_arrival": {
            "$ref": "#/components/schemas/calendar_allocation_on_arrival_object"
          }
        }
      },
      "calendar_allocation_on_arrival_object": {
        "required": [
          "availability",
          "available_unit_count",
          "change_over",
          "max_stay",
          "min_prior_notify",
          "min_stay",
          "stay_increment"
        ],
        "properties": {
          "availability": {
            "type": "string",
            "description": "List of availability codes for each day."
          },
          "available_unit_count": {
            "type": "string",
            "description": "Comma-separated list of the number of available units for each day."
          },
          "change_over": {
            "type": "string",
            "description": "List of codes that define the check-in/checkout policy for each day."
          },
          "max_stay": {
            "type": "string",
            "description": "Comma-separated list of the maximum number of days allowed in a stay for each day."
          },
          "min_prior_notify": {
            "type": "string",
            "description": "Comma-separated list of the minimum numbers of days required to book the stay before the check-in date.."
          },
          "min_stay": {
            "type": "string",
            "description": "Comma-separated list of the minimum number of days required for a stay for each day."
          },
          "stay_increment": {
            "type": "string",
            "description": "List of values that indicate how much to increment the minimum stay for each day."
          }
        }
      },
      "calendar_days": {
        "properties": {
          "days": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/calendar_day"
            }
          }
        }
      },
      "calendar_day": {
        "allOf": [
          {
            "$ref": "#/components/schemas/calendar_settings"
          }
        ],
        "required": [
          "date",
          "availability",
          "availability_type",
          "closed_to_arrival",
          "closed_to_depature",
          "minimum_nights",
          "maximum_nights",
          "settings",
          "stay_durations"
        ],
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time"
          },
          "availability": {
            "type": "string"
          },
          "availability_type": {
            "type": "string"
          },
          "closed_to_arrival": {
            "type": "boolean"
          },
          "closed_to_depature": {
            "type": "boolean"
          },
          "minimum_nights": {
            "type": "integer"
          },
          "maximum_nights": {
            "type": "integer"
          },
          "settings": {
            "type": "integer"
          },
          "stay_durations": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          }
        }
      },
      "calendar_settings": {
        "properties": {
          "settings": {
            "$ref": "#/components/schemas/calendar_setting"
          }
        }
      },
      "calendar_setting": {
        "required": [
          "booking_fence",
          "gap_days",
          "minimum_nights",
          "maximum_nights",
          "arrival_days",
          "departure_days"
        ],
        "properties": {
          "booking_fence": {
            "type": "integer"
          },
          "gap_days": {
            "type": "integer"
          },
          "minimum_nights": {
            "type": "integer"
          },
          "maximum_nights": {
            "type": "integer"
          },
          "arrival_days": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "departure_days": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          }
        }
      }
    }
  }
}
```