Guides
Start typing to search…

Retrieve Unit Amenities

Returns amenity details for units in the inventory

Overview

The Retrieve Unit Amenities endpoint allows the Agent to retrieve amenity data associated with units within their accessible Inventory, either in bulk or for a specific unit.

This endpoint returns listing-level amenity metadata configured by the supplier in the CiiRUS system. Amenities may include general property features, as well as channel-specific amenity mappings (for example, Airbnb- or Vrbo-specific amenity classifications), depending on how the listing is configured and the requested channel context.

This data is commonly used to populate property detail pages, filter and search experiences, and align amenity representations across distribution channels.

Related Supplier Configuration (Optional Context)

The amenities returned by this endpoint are configured and maintained by the supplier within the CiiRUS platform. Availability and structure of amenities may vary by channel.

Endpoints Available

MethodEndpointDescription
GETv2024.07.31/unit_amenitiesReturns amenities for units in the inventory.
GETv2024.07.31/unit_amenities/{unit_id}Returns amenities for a specified 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
page_sizeOptionalLimits 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_idOptionalUnique Identifier for a unit in the inventory.int
unit_idsOptionalUnique Identifiers for multiple units within the inventory.array
management_company_user_idOptionalUnique Identifier for a supplier of units.int
management_company_user_idsOptionalUnique Identifiers for multiple suppliers of units.array
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 management company's 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
listing_idOptionalLookup a unit by its channel-specific listing ID.string
channelOptionalRestrict results to a specific channel’s configuration context. Leave empty for the default/general image set.string

Allowed values for channel:

    • all
    • bdc
    • vrbo
    • airbnb

Channel-Specific Amenity Behavior

When a channel filter is applied, the amenity values and structure returned may vary based on the selected channel’s classification system. Each channel maintains its own amenity taxonomy and supported values.

For a complete list of channel-specific amenity enumerations, refer to the following reference:

Not all amenities apply to all channels, and some channel-specific amenities may not be present for every unit.

🚧

If amenity data is missing or incomplete, this does not indicate a technical error or API issue. Amenities are configured by the Property Manager. Contact the supplier to review or update listing amenity configuration in CiiRUS.

Response Definition

Response ItemDescriptionData Type
"unit_id"The unique identifier for the unit associated with the listed amenities.int
"management_company_user_id"The ID of the management company assigned to the unit.
"amenities"A list of amenities available for the unit. Each element in the array represents a specific amenity provided by the unit as configured by the management company.array
"error" (Optional)Error object indicating an issue with the unit (If applicable).string

"error" Object

Response ItemDescriptionData Type
"message"A descriptiive message for the error (e.g., deletion).string

Sample Request

curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_amenities' \
--header 'Authorization: Basic {APIUsername:APIPassword}'

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

Sample Response

{
    "unit_amenities": [
        {
            "unit_id": 219264,
            "management_company_user_id": 42330,
            "amenities": [
                "CommunalPool",
                "Pool",
                "Spa",
                "OutDoorHotTub",
                "IndoorHotTub",
                "FreeSolarHeatedPool",
                "PrivatePoolHeatable",
                "SouthFacingPool",
                "PoolAccess",
                "IndoorJacuzzi",
                "Dryer",
                "DiningTable",
                "Bbq",
                "Grill",
                "HairDryer",
                "PartialKitchen",
                "Dishwasher",
                "MiniKitchen",
                "FullKitchen",
                "ResortAmenities",
                "Elevator",
                "WheelChairAccessible",
                "FreeCalls",
                "PavedParking",
                "RockingChairs",
                "Microwave",
                "LaundryInUnit",
                "LaundryOnSite",
                "UnitAmenities",
                "Dock",
                "MotorCycle",
                "BoatSlip",
                "Wifi",
                "WiredInternetAccess",
                "Internet",
                "Stroller",
                "Crib",
                "PacknPlay",
                "HighChair",
                "ElectricFireplace",
                "WoodBurningFireplace",
                "UnderFloorHeating",
                "GasFirePlace",
                "AirCon",
                "ConservationView",
                "GolfView",
                "BeachAccess",
                "WalkingDistanceToTown",
                "WaterView",
                "OceanFront",
                "SeaView",
                "Waterfront",
                "GamesRoom",
                "CommunalGym",
                "AirHockeyTable",
                "FoosballTable",
                "PoolTable",
                "VideoGames",
                "Vcr",
                "TableTennis",
                "ClubAndResort",
                "GolfIncluded",
                "BigScreenTv",
                "TvInEveryBedroom",
                "CdPlayer",
                "DvdPlayer",
                "Fishing",
                "ClubHouse",
                "TennisCourts",
                "PetsAllowed",
                "GasFree",
                "PrivacyFence",
                "BeachOnSite"
            ]
        },
        {
            "unit_id": 222003,
            "management_company_user_id": 42330,
            "amenities": [
                "Pool",
                "PrivatePoolHeatable"
            ],
            "error": {
                "message": "Property has been deleted."
            }
        },
		...
	],
    "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/unit_amenities?page=2&page_size=25",
        "total_page_count": 13,
        "page": 1,
        "page_size": 25
    }
}

Updated about 19 hours ago