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

# Retrieve unit details

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2024.07.31"
  },
  "paths": {
    "/unit_details/{unit_id}": {
      "get": {
        "summary": "Retrieve unit details",
        "description": "",
        "parameters": [
          {
            "$ref": "#/components/parameters/unit_id_path"
          },
          {
            "$ref": "#/components/parameters/channel_query"
          }
        ],
        "responses": {
          "200": {
            "description": "Unit details response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/retrieve_unit_details_response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "tags": [
          "Unit Details"
        ]
      }
    }
  },
  "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"
          ]
        }
      }
    },
    "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"
          }
        }
      },
      "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"
          },
          {
            "$ref": "#/components/schemas/door_code"
          }
        ]
      },
      "lock_box_code": {
        "properties": {
          "lock_box_code": {
            "description": "Code for lock box access.",
            "type": "string"
          }
        }
      },
      "gate_code": {
        "properties": {
          "gate_code": {
            "description": "Code for gate access.",
            "type": "string"
          }
        }
      },
      "alarm_code": {
        "properties": {
          "alarm_code": {
            "description": "Code for alarm access.",
            "type": "string"
          }
        }
      },
      "wifi_ssid": {
        "properties": {
          "wifi_ssid": {
            "description": "Wifi network name.",
            "type": "string"
          }
        }
      },
      "wifi_password": {
        "properties": {
          "wifi_password": {
            "description": "Wifi password.",
            "type": "string"
          }
        }
      },
      "lobby_code": {
        "properties": {
          "lobby_code": {
            "description": "Code for lobby access.",
            "type": "string"
          }
        }
      },
      "fitness_room_code": {
        "properties": {
          "fitness_room_code": {
            "description": "Code for fitness room access.",
            "type": "string"
          }
        }
      },
      "pool_access_code": {
        "properties": {
          "pool_access_code": {
            "description": "Code for pool access.",
            "type": "string"
          }
        }
      },
      "beach_access_code": {
        "properties": {
          "beach_access_code": {
            "description": "Code for beach access.",
            "type": "string"
          }
        }
      },
      "door_code": {
        "properties": {
          "door_code": {
            "description": "Code for door access.",
            "type": "string"
          }
        }
      },
      "pool_heat_details": {
        "properties": {
          "pool_heat_details": {
            "$ref": "#/components/schemas/pool_heat_detail"
          }
        }
      },
      "pool_heat_detail": {
        "allOf": [
          {
            "$ref": "#/components/schemas/discount_offered_notes"
          },
          {
            "$ref": "#/components/schemas/south_facing_notes"
          },
          {
            "$ref": "#/components/schemas/required_notice_before_arrival_notes"
          },
          {
            "$ref": "#/components/schemas/fee_to_turn_on_if_guest_in_house_notes"
          },
          {
            "$ref": "#/components/schemas/pool_heat_notes"
          }
        ]
      },
      "discount_offered_notes": {
        "properties": {
          "discount_offered_notes": {
            "description": "Notes on pool heating discounts that are offered.",
            "type": "string"
          }
        }
      },
      "south_facing_notes": {
        "properties": {
          "south_facing_notes": {
            "description": "South-facing pool notes.",
            "type": "string"
          }
        }
      },
      "required_notice_before_arrival_notes": {
        "properties": {
          "required_notice_before_arrival_notes": {
            "description": "Required notice prior to guest arrival.",
            "type": "string"
          }
        }
      },
      "fee_to_turn_on_if_guest_in_house_notes": {
        "properties": {
          "fee_to_turn_on_if_guest_in_house_notes": {
            "description": "Notes relating to turn-in fee when guest in-house.",
            "type": "string"
          }
        }
      },
      "pool_heat_notes": {
        "properties": {
          "pool_heat_notes": {
            "description": "General notes relating to pool / spa heating.",
            "type": "string"
          }
        }
      },
      "retrieve_unit_details_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_details_response"
          },
          {
            "type": "object"
          }
        ]
      },
      "error_object": {
        "properties": {
          "error": {
            "$ref": "#/components/schemas/error"
          }
        }
      },
      "error": {
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message."
          }
        }
      },
      "unit_details_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_id"
          },
          {
            "$ref": "#/components/schemas/management_company_user_id"
          },
          {
            "$ref": "#/components/schemas/details"
          },
          {
            "$ref": "#/components/schemas/error_object"
          }
        ],
        "required": [
          "unit_id",
          "management_company_user_id",
          "details"
        ]
      },
      "details": {
        "properties": {
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/detail"
            }
          }
        }
      },
      "detail": {
        "properties": {
          "unit_name": {
            "type": "string"
          },
          "description_set_id": {
            "type": "integer"
          },
          "terms_and_conditions": {
            "$ref": "#/components/schemas/terms_and_conditions"
          },
          "time_zone": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "location": {
            "$ref": "#/components/schemas/location"
          },
          "geo_code": {
            "$ref": "#/components/schemas/geo_code"
          },
          "description": {
            "$ref": "#/components/schemas/description_text"
          },
          "arrival_time": {
            "type": "string"
          },
          "departure_time": {
            "type": "string"
          },
          "area": {
            "type": "integer"
          },
          "area_unit": {
            "type": "string"
          },
          "max_occupants": {
            "type": "integer"
          },
          "bedrooms": {
            "type": "integer"
          },
          "king_beds": {
            "type": "integer"
          },
          "queen_beds": {
            "type": "integer"
          },
          "full_beds": {
            "type": "integer"
          },
          "single_twin_beds": {
            "type": "integer"
          },
          "bathrooms": {
            "type": "number",
            "format": "float"
          },
          "class": {
            "type": "string",
            "enum": [
              "standard",
              "superior",
              "deluxe",
              "ultimate",
              "superior_deluxe_with_gameroom_spa",
              "special"
            ]
          },
          "type": {
            "type": "string"
          },
          "restrictions": {
            "$ref": "#/components/schemas/restrictions"
          },
          "channel_ids": {
            "$ref": "#/components/schemas/channel_ids"
          },
          "tax_1_remitted_by_host": {
            "type": "boolean"
          },
          "tax_2_remitted_by_host": {
            "type": "boolean"
          },
          "tax_3_remitted_by_host": {
            "type": "boolean"
          },
          "commercial": {
            "type": "boolean"
          },
          "furnished": {
            "type": "boolean"
          },
          "long_term": {
            "type": "boolean"
          },
          "rating": {
            "type": "number",
            "format": "float"
          },
          "telephone": {
            "type": "string"
          },
          "bedroom_configuration": {
            "type": "string"
          },
          "arrival_departure_details": {
            "type": "string"
          },
          "secure_details": {
            "$ref": "#/components/schemas/secure_details"
          },
          "pool_heat_details": {
            "$ref": "#/components/schemas/pool_heat_details"
          },
          "comments": {
            "type": "string"
          },
          "booking_restrictions": {
            "type": "string"
          }
        },
        "required": [
          "unit_name",
          "description_set_id",
          "time_zone",
          "active",
          "address",
          "geo_code",
          "description",
          "arrival_time",
          "departure_time",
          "area",
          "area_unit",
          "max_occupants",
          "bedrooms",
          "king_beds",
          "queen_beds",
          "full_beds",
          "single_twin_beds",
          "bathrooms",
          "class",
          "type",
          "restrictions",
          "commercial",
          "furnished",
          "long_term"
        ]
      },
      "address": {
        "properties": {
          "address_line_1": {
            "type": "string"
          },
          "address_line_2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state_province": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "postal_code": {
            "type": "string"
          }
        },
        "required": [
          "address_line_1",
          "city",
          "state_province",
          "country",
          "postal_code"
        ]
      },
      "location": {
        "properties": {
          "id": {
            "type": "string"
          },
          "community": {
            "type": "string"
          },
          "lat": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "long": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "gated": {
            "type": "boolean"
          },
          "city": {
            "$ref": "#/components/schemas/city"
          }
        },
        "required": [
          "id",
          "community",
          "lat",
          "long",
          "gated",
          "city"
        ]
      },
      "city": {
        "properties": {
          "id": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "lat": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "long": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "state": {
            "$ref": "#/components/schemas/state"
          }
        },
        "required": [
          "id",
          "city",
          "lat",
          "long",
          "state"
        ]
      },
      "state": {
        "properties": {
          "id": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "lat": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "long": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "country": {
            "$ref": "#/components/schemas/country"
          }
        },
        "required": [
          "id",
          "state",
          "lat",
          "long",
          "country"
        ]
      },
      "country": {
        "properties": {
          "id": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "country_code": {
            "type": "string"
          },
          "lat": {
            "type": "integer",
            "multipleOf": 1e-15
          },
          "long": {
            "type": "integer",
            "multipleOf": 1e-15
          }
        },
        "required": [
          "id",
          "country",
          "country_code",
          "lat",
          "long"
        ]
      },
      "geo_code": {
        "properties": {
          "latitude": {
            "type": "number"
          },
          "longitude": {
            "type": "number"
          }
        },
        "required": [
          "latitude",
          "longitude"
        ]
      },
      "terms_and_conditions": {
        "properties": {
          "id": {
            "type": "number"
          },
          "management_company_user_id": {
            "type": "number"
          },
          "terms_name": {
            "type": "string"
          },
          "plain_text_terms": {
            "type": "string"
          },
          "terms": {
            "type": "string"
          },
          "cancellation_policy": {
            "type": "string"
          },
          "local_charges": {
            "type": "string"
          },
          "language_id": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "management_company_user_id",
          "terms_name",
          "plain_text_terms",
          "terms",
          "cancellation_policy",
          "local_charges",
          "language_id"
        ]
      },
      "description_text": {
        "properties": {
          "text": {
            "type": "string"
          }
        },
        "required": [
          "text_type",
          "text"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/text_type"
          }
        ]
      },
      "restrictions": {
        "properties": {
          "min_guest_age": {
            "type": "integer"
          },
          "smoking_allowed": {
            "type": "boolean"
          },
          "pets_allowed": {
            "type": "boolean"
          },
          "surveillance": {
            "type": "boolean"
          },
          "children_allowed": {
            "type": "boolean"
          },
          "events_allowed": {
            "type": "boolean"
          }
        },
        "required": [
          "min_guest_age",
          "smoking_allowed",
          "pets_allowed",
          "surveillance",
          "children_allowed",
          "events_allowed"
        ]
      },
      "text_type": {
        "properties": {
          "text_type": {
            "type": "string",
            "enum": [
              "plain_text_description",
              "plain_text_location",
              "headline",
              "title",
              "overview",
              "bullet_point_one",
              "bullet_point_two",
              "bullet_point_three",
              "bullet_point_four",
              "bullet_point_five"
            ]
          }
        }
      },
      "channel_ids": {
        "properties": {
          "airbnb": {
            "type": "string"
          },
          "booking_dot_com": {
            "type": "string"
          },
          "booking_sync": {
            "type": "string"
          },
          "booking_pals": {
            "type": "string"
          },
          "expedia": {
            "type": "string"
          },
          "guesty": {
            "type": "string"
          },
          "vrbo": {
            "type": "string"
          },
          "orbirental": {
            "type": "string"
          },
          "rentals_united": {
            "type": "string"
          },
          "site_minder": {
            "type": "string"
          },
          "trip_advisor": {
            "type": "string"
          },
          "wheelhouse": {
            "type": "string"
          }
        }
      }
    }
  }
}
```