Retrieve Unit Details

Returns content details for the Inventory

Overview

The Retrieve Unit Details request allows the Agent to obtain comprehensive information about the content details of all units within the Inventory or a specific unit.

By making this request, partners can retrieve all relevant content details associated with a Property. The API provides various content elements, such as property descriptions, location descriptions, and other pertinent details.

Endpoints Available

MethodEndpointDescription
GETv2024.07.31/unit_detailsReturns content details for units in the inventory.
GETv2024.07.31/unit_details/{unit_id}Returns content details for a specific unit in the inventory.

Path Parameters

Path ParameterRequired / OptionalDescription
{unit_id}RequiredUnique Identifier for a unit in the inventory.

Query String Parameters

ParameterRequired / OptionalDescriptionData Type
pageOptionalThe page to be shown (defaults to 1).int
pageSizeOptionalLimits the number of returned results (defaults to 25).int
last_unit_update_dateOptionalOnly return units that have been modified after the specified date.date-time
last_reservation_update_dateOptionalOnly return units that have received a booking (their own or a calendar sync) after the specified date.date-time
last_agent_module_property_update_dateOptionalOnly return units that have had their agent module property configuration modified after the specified date.date-time
last_agent_module_agent_update_dateOptionalOnly return units that have had their agent module agent configuration modified after the specified date.date-time
unit_idOptionalThe unique identifier for a unit in the inventory.int
unit_idsOptionalThe unique identifiers for multiple units in the inventory.array[int]
management_company_user_idOptionalThe unique identifier for a supplier of units in the inventory.int
management_company_user_idsOptionalThe unique identifiers for multiple suppliers of units in the inventory.array[int]
enabledOptionalUse only enabled or disabled units.boolean
deletedOptionalOnly show properties that are deleted or not deleted.boolean
display_on_websiteOptionalOnly show properties that are enabled for the website.boolean
allocation_on_arrivalOptionalReturn the allocation on arrival object.boolean
allocation_on_arrival_unitOptionalReturn units that are the representative unit in their group.boolean
airbnbOptionalReturn additional context information relating to Airbnbstring

Response Definition

Response ItemDescriptionData Type
"unit_details"An array containing detailed information about a specific unit/property in the inventory.array

"unit_details" Object

Response ItemDescriptionData Type
"unit_id"The unique identifier for the unit.int
"management_company_user_id"The unique ID of the management company that owns or manages the unit.int
"details"An object containing data related to the unit’s configuration, description, location, and restrictions.object

"details" Object

Response ItemDescriptionData Type
"unit_name"The internal display name of the unit. This should not be guest-facing and remain internal only, if applicable.string
"description_set_id"The unique identifier for the description set assigned to the unit.int
"terms_and_conditions"An object containing information about the terms and conditions of the unit.object
"time_zone"The UTC offset of the unit's local time zone, specified in the format (e.g., -05:00:00).string
"active"A flag indicating whether the unit is currently active (true) or not (false).boolean
"address"An object containing the physical address details of the unit.object
"location"An object containing further location details of the unit.object
"geo_code"An object containing the geographic coordinates of the unitobject
"description"An array of objects containing different types of property descriptions.array
"arrival_time"The time when guests can check in to the unit, in the format "HH:MM".string
"departure_time"The time when guests must check out of the unit, in the format "HH:MM".string
"area"The square footage of the unit.int
"max_occupants"The maximum number of occupants allowed in the unit.int
"bedrooms"The number of bedrooms in the unit.int
"king_beds"The number of king-size beds in the unit.int
"queen_beds"The number of queen-size beds in the unit.int
"full_beds"The number of full-size beds in the unit.int
"single_twin_beds"The number of single/twin beds in the unit.int
"bathrooms"The number of bathrooms in the unit.float
"class"The internal classification or category of the unit.string
"type"The type of property that defines the unit.string
"restrictions"An object containing various restrictions or rules related to the unit.object
"commercial"A flag indicating whether the unit is commercial (true) or not (false).boolean
"furnished"A flag indicating whether the unit is furnished (true) or not (false).boolean
"long_term"A flag indicating if the property is available for long-term rentals (true) or not (false).boolean
"telephone"The phone number associated with the unit.string
"rating"The internal rating score for the unit.float
"bedroom_configuration"Description of bed layouts of the unit.string
"arrival_departure_details"Any special check-in/out instructions set by the management company or unit owner.string
"secure_details"An object containing access codes and network info assigned to the unit, if applicable.object
"pool_heat_details"An object containing pool heat-related information for the unit.object
"comments"Freeform comments related to the unit.string
"booking_restrictions"Any custom booking-related restrictions set by the management company or unit owner.string

"terms_and_conditions" Object

Response ItemDescriptionData Type
"id"The unique identifier for the terms and conditions.int
"mc_user_id"The unique identifier for the supplier associated with the terms and conditions.int
"terms_name"The name or title of the terms and conditions.string
"terms"The content of the terms and conditions in full HTML format.string
"plain_text_terms"The content of the terms and conditions in plain text.string
"cancellation_policy"The policy regarding cancellations for the property unitstring

"address" Object

Response ItemDescriptionData Type
"address_line_1"The primary street address of the unit.string
"address_line_2"The secondary address information of the unit, if applicable (e.g., unit, suite number).string
"city"The city where the unit is located.string
"state_province"The state or province where the unit is located.string
"country"The country where the unit is located in ISO 3166 (alpha-2) format.string
"postal_code"The postal code of the unit.string

"location" Object

Response ItemDescriptionData Type
"id"The ID of the community or resort this unit belongs to.int
"community"The name of the community or resort.string
"gated"A flag indicating whether the community is gated (true) or not (false).boolean
"city"A nested object with city, state, and country info. See below.object
"timezone"The IANA timezone format of the unit location (e.g., "America/New_York").string

"location.city" Object

Response ItemDescriptionData Type
"id"The unique City ID.int
"city"The City name.string
"state"A nested object containing state and country info.object

"location.city.state" Object

Response ItemDescriptionData Type
"id"The unique State ID.int
"state"The State name.string
"country"The Country object with ID, name, and code.object

"location.city.state.country" Object

Response ItemDescriptionData Type
"id"The unique Country ID.int
"country"The Country name.string
"country_code"The ISO 3166 (alpha-2) formatted Country code.string

"geo_code" Object

Response ItemDescriptionData Type
"latitude"The latitude coordinate of the unit's location.float
"longitude"The longitude coordinate of the unit's location.float

"description" Object

Response ItemDescriptionData Type
"text_type"A description of what the "text" contains.string
"text"The content of the "text_type".string

"restrictions" Object

Response ItemDescriptionData Type
"min_guest_age"The minimum age of the primary guests allowed to book the unit.int
"smoking_allowed"A flag indicating whether smoking is allowed in the unit (true) or not (false).boolean
"pets_allowed"A flag indicating whether pets are allowed in the unit (true) or not (false).boolean
"surveillance"A flag indicating whether the unit has surveillance equipment (true) or not (false).boolean
"children_allowed"A flag to indicate whether children are allowed in the unit (true) or not (false).boolean
"events_allowed"A flag to indicate whether events/parties are allowed in the unit (true) or not (false).boolean

"secure_details" Object

Response ItemDescriptionData Type
"gate_code"The community gate access code, if applicable.string
"alarm_code"The alarm system code for the unit, if applicable.string
"wifi_ssid"The WiFi network name for the unit, if configured by the management company.string
"wifi_password"The WiFi password, if configured by the management company.string
"door_code"The Smart lock code for the unit, if any.string

"pool_heat_details" Object

Response ItemDescriptionData Type
"discount_offered_notes"Notes about any discount on pool heat (if applicable).string
"south_facing_notes"Notes indicating if the pool is south-facing.string
"required_notice_before_arrival_notes"The advance notice required to activate the pool heat.string
"fee_to_turn_on_if_guest_in_house_notes"Policy/notes on charging a fee if a guest requests heat after arrival.string
"pool_heat_notes"Any custom pool heat-related notes set by the management company or unit owner.string

🚧

If any Unit Details are missing or blank, it is not indicative of a technical error. Rather, please contact the Property Manager and request that they update the Listing Content Details of the Description Set assigned to this Propertyfor your Agent channel.

Sample Request

curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_details?page=1&page_size=25&no_total=false' \
--header 'Authorization: Basic {APIUsername:APIPassword}'

Sample Response

{
    "unit_details": [
        {
            "unit_id": 219264,
            "management_company_user_id": 42330,
            "details": {
                "unit_name": "Test Property 1",
                "description_set_id": 406513,
                "terms_and_conditions": {
                    "id": 8835,
                    "mc_user_id": 42330,
                    "terms_name": "Terms&Conditions ",
                    "terms": "<p>Terms and Conditions<br /><br /><br />Acceptance of Terms By accessing and using this website, you acknowledge and agree to be bound by these terms and conditions.<br /><br /><br />Intellectual Property&nbsp;<br />All content on this website, including but not limited to text, graphics, logos, images, and software, is the property of the website owner and is protected by applicable intellectual property laws. You may not use, reproduce, distribute, or modify any content without prior written permission.<br /><br /><br />User Conduct&nbsp;<br />When using this website, you agree not to engage in any prohibited activities, including but not limited to:<br /><br />Violating any applicable laws or regulations<br /><br />Interfering with the website's operation or other users' access<br /><br />Uploading or transmitting harmful or offensive content<br /><br />Attempting to gain unauthorized access to the website's systems<br /><br /><br />Third-Party Links This website may contain links to third-party websites for your convenience. However, we do not endorse or assume any responsibility for the content or practices of these websites. Use them at your own risk.<br /><br /><br />Limitation of Liability&nbsp;<br />The website owner shall not be held liable for any damages arising from the use or inability to use the website, including but not limited to direct, indirect, incidental, or consequential damages.<br /><br /><br />Disclaimer&nbsp;<br />This website is provided on an \"as is\" basis without any warranties, express or implied. We make no representations or warranties regarding the accuracy, completeness, or reliability of the content.<br /><br /><br />Privacy&nbsp;<br />We are committed to protecting your privacy. Please refer to our Privacy Policy for information on how we collect, use, and disclose personal data.<br /><br /><br />Modifications&nbsp;<br />We reserve the right to modify these terms and conditions at any time without prior notice. It is your responsibility to review them periodically.<br /><br /><br />Governing Law and Jurisdiction&nbsp;<br />These terms and conditions shall be governed by and construed in accordance with the laws of [your jurisdiction].<br /><br />Cancellation Policy -<br />We understand that plans can change, and sometimes it becomes necessary to cancel or modify a reservation. To ensure transparency and clarity, we have established the following cancellation policy for our short-term vacation rentals:<br /><br />Cancellation Period:<br /><br />[Number of Days] or more prior to the check-in date: Full refund of the reservation amount.<br />Less than [Number of Days] prior to the check-in date: No refund.<br />Modification Requests:<br /><br />Requests to modify the reservation dates are subject to availability and must be made [Number of Days] or more prior to the check-in date. Additional charges may apply based on the revised booking details.<br />No-Shows or Early Departures:<br /><br />No-shows or early departures will not be eligible for any refund.<br />Refund Process:<br /><br />Refunds, if applicable, will be processed within [Number of Days] of the cancellation date.<br />Please note that the refund may take additional time to reflect in your account depending on your bank or payment provider.<br />Please review and understand the cancellation policy before making a reservation. By proceeding with the booking, you acknowledge and accept the terms outlined in this policy.</p>",
                    "plain_text_terms": "Terms and Conditions\r\n\n\nAcceptance of Terms By accessing and using this website, you acknowledge and agree to be bound by these terms and conditions.\n\n\r\nIntellectual Property \r\nAll content on this website, including but not limited to text, graphics, logos, images, and software, is the property of the website owner and is protected by applicable intellectual property laws. You may not use, reproduce, distribute, or modify any content without prior written permission.\r\n\n\nUser Conduct \r\nWhen using this website, you agree not to engage in any prohibited activities, including but not limited to:\n\nViolating any applicable laws or regulations\r\n\nInterfering with the website's operation or other users' access\n\r\nUploading or transmitting harmful or offensive content\n\r\nAttempting to gain unauthorized access to the website's systems\n\n\r\nThird-Party Links This website may contain links to third-party websites for your convenience. However, we do not endorse or assume any responsibility for the content or practices of these websites. Use them at your own risk.\n\n\r\nLimitation of Liability \r\nThe website owner shall not be held liable for any damages arising from the use or inability to use the website, including but not limited to direct, indirect, incidental, or consequential damages.\n\n\r\nDisclaimer \r\nThis website is provided on an \"as is\" basis without any warranties, express or implied. We make no representations or warranties regarding the accuracy, completeness, or reliability of the content.\n\n\r\nPrivacy \r\nWe are committed to protecting your privacy. Please refer to our Privacy Policy for information on how we collect, use, and disclose personal data.\r\n\n\nModifications \r\nWe reserve the right to modify these terms and conditions at any time without prior notice. It is your responsibility to review them periodically.\n\n\r\nGoverning Law and Jurisdiction \r\nThese terms and conditions shall be governed by and construed in accordance with the laws of [your jurisdiction].",
                    "cancellation_policy": "We understand that plans can change, and sometimes it becomes necessary to cancel or modify a reservation. To ensure transparency and clarity, we have established the following cancellation policy for our short-term vacation rentals:\r\n\r\nCancellation Period:\r\n\r\n[Number of Days] or more prior to the check-in date: Full refund of the reservation amount.\r\nLess than [Number of Days] prior to the check-in date: No refund.\r\nModification Requests:\r\n\r\nRequests to modify the reservation dates are subject to availability and must be made [Number of Days] or more prior to the check-in date. Additional charges may apply based on the revised booking details.\r\nNo-Shows or Early Departures:\r\n\r\nNo-shows or early departures will not be eligible for any refund.\r\nRefund Process:\r\n\r\nRefunds, if applicable, will be processed within [Number of Days] of the cancellation date.\r\nPlease note that the refund may take additional time to reflect in your account depending on your bank or payment provider.\r\nPlease review and understand the cancellation policy before making a reservation. By proceeding with the booking, you acknowledge and accept the terms outlined in this policy."
                },
                "time_zone": "-05:00:00",
                "active": true,
                "address": {
                    "address_line_1": "1012 Emmette St",
                    "address_line_2": "Suite A",
                    "city": "Kissimmee ",
                    "state_province": "Fl",
                    "country": "USA",
                    "postal_code": "34741"
                },
                "location": {
                    "id": 17511,
                    "community": "Encore Resort at Reunion ",
                    "gated": false,
                    "city": {
                        "id": 2,
                        "city": "Central Florida/Orlando",
                        "state": {
                            "id": 2,
                            "state": "Florida",
                            "country": {
                                "id": 2,
                                "country": "USA",
                                "country_code": "US"
                            }
                        }
                    },
                    "timezone": "America/New_York"
                },
                "geo_code": {
                    "latitude": 28.2912883,
                    "longitude": -81.4148344
                },
                "description": [
                    {
                        "text_type": "plain_text_description",
                        "text": "Test Property 1 Plaintext<br><br>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis placerat vitae sapien vitae faucibus. Etiam congue suscipit sem, a euismod ipsum accumsan ac. Maecenas est sem, accumsan eget magna id, egestas cursus est. Etiam molestie, lorem eget luctus blandit, lorem felis scelerisque sem, id maximus ipsum justo eget massa. Maecenas ultrices lobortis eros, sed tempor lacus accumsan quis. Donec convallis consectetur tincidunt. Fusce ligula nulla, elementum tristique consequat a, tempor vitae metus.<br><br>Vivamus efficitur urna mauris, vel lacinia arcu rutrum quis. Vestibulum dictum nulla ut ante egestas, eu vehicula risus ultricies. Ut semper vitae justo vel iaculis. Sed volutpat lorem lorem, et accumsan ligula condimentum a. Suspendisse molestie tortor ac condimentum mollis. Quisque ipsum tortor, laoreet a magna nec, venenatis semper ex. Nam mollis nulla id nisi dapibus tristique. Fusce vel velit in libero scelerisque lobortis nec nec ipsum. Nunc tristique tellus malesuada, gravida magna sed, tincidunt sapien. Quisque in consequat sem. Donec quis velit rhoncus, feugiat tellus rhoncus, viverra nibh. Quisque at pulvinar nisi, a consequat risus. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin facilisis fringilla tellus ut sollicitudin. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse commodo eros vel aliquam molestie.<br><br>Suspendisse in feugiat diam, vitae hendrerit eros. Praesent molestie massa sed est malesuada viverra. Vestibulum fermentum massa leo, non finibus turpis suscipit eget. In pellentesque, nisl ut pulvinar porttitor, quam ipsum porta quam, ornare elementum augue augue vitae justo. Fusce eget dui nibh. Nullam ornare lacus sed neque laoreet ullamcorper. Phasellus eget sollicitudin erat, dictum auctor urna. Donec sodales porta mauris, non efficitur enim aliquam in. Ut consequat metus in nisl ornare tincidunt. Aenean id lacus varius, convallis nunc sed, aliquet libero. Phasellus pretium dapibus diam, id dapibus diam. Morbi nisl nibh, malesuada et ultrices vel, posuere in tellus. Maecenas in tortor commodo, semper neque ut, interdum enim."
                    },
                    {
                        "text_type": "bullet_point_one",
                        "text": "Is Nice"
                    },
                    {
                        "text_type": "bullet_point_two",
                        "text": "Would stay here"
                    },
                    {
                        "text_type": "bullet_point_three",
                        "text": "has features"
                    },
                    {
                        "text_type": "bullet_point_four",
                        "text": "has doors"
                    },
                    {
                        "text_type": "bullet_point_five",
                        "text": "has windows"
                    },
                    {
                        "text_type": "headline",
                        "text": "Test Property 1 Headline"
                    },
                    {
                        "text_type": "title",
                        "text": "Test Property 1 - Description Title"
                    },
                    {
                        "text_type": "plain_text_location"
                    }
                ],
                "arrival_time": "16:00",
                "departure_time": "10:00",
                "area": 8000,
                "max_occupants": 20,
                "bedrooms": 0,
                "king_beds": 4,
                "queen_beds": 2,
                "full_beds": 2,
                "single_twin_beds": 3,
                "bathrooms": 2.0,
                "class": "superior_deluxe_with_game_room_spa",
                "type": "House",
                "restrictions": {
                    "min_guest_age": 25,
                    "smoking_allowed": false,
                    "pets_allowed": true,
                    "surveillance": true,
                    "children_allowed": false,
                    "events_allowed": true
                },
                "commercial": false,
                "furnished": true,
                "long_term": false,
                "telephone": "1231231234",
                "rating": 7.5,
                "bedroom_configuration": "24x300 - 12x96",
                "arrival_departure_details": "Test Arrival/Departure Info",
                "secure_details": {
                    "gate_code": "0856",
                    "alarm_code": "2150",
                    "wifi_ssid": "MyNetworkPW123",
                    "wifi_password": "MyNetwork",
                    "door_code": ""
                },
                "pool_heat_details": {
                     "discount_offered_notes": "N/A",
                    "south_facing_notes": "N/A",
                    "required_notice_before_arrival_notes": "72 HOURS",
                    "fee_to_turn_on_if_guest_in_house_notes": "N/A- WILL NOT ALLOW",
                    "pool_heat_notes": "-"
                },
                "comments": "Test Comments",
                "booking_restrictions": "Test Booking Restrictions"
            }
        }, ...
    ],
 "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/units?page=2&page_size=25&no_total=false",
        "total_page_count": 129,
        "page": 1,
        "page_size": 25
    }
}