Overview

The Retrieve Unit Amenities endpoint allows an Agent to retrieve amenity classifications associated with units in 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 represent the features, facilities, and characteristics of a unit that may be surfaced to guests or used internally for filtering, merchandising, and channel distribution.

The data returned by this endpoint is commonly used to:

Populating guest-facing property detail pages
Powering search filters and faceted browsing (for example: “Pool”, “Pets Allowed”, “Wheelchair Accessible”)
Normalizing listing feature representations across suppliers and inventory sources
Supporting downstream merchandising and eligibility logic (for example: highlighting “PrivatePoolHeatable” or “BeachAccess”)

Related Supplier Configuration (Optional Context)

The amenities returned by this endpoint are configured and maintained by the supplier within the CiiRUS platform. Availability, completeness, and structure of amenities may vary based on how the supplier has configured their listings.

General listing amenities (maps to default amenity configurations)
- General listing features & amenities
Airbnb-specific amenities (maps to channel-scoped "airbnb" amenity configurations)
- Airbnb listing features & amenities
Vrbo-specific amenities (maps to channel-scoped "vrbo" amenity configurations)
- Vrbo listing features & amenities

Channel Context (Optional)

The channel parameter allows amenities to be returned using a channel-specific mapping and taxonomy, reflecting how the supplier has classified amenities for a particular distribution channel (such as Airbnb or Vrbo).

When channel is not provided, the endpoint returns the unit’s default amenity set, which represents the supplier’s general amenity configuration and is typically suitable for most integrations.

When channel is provided:

Additional amenities may be returned that are only configured at the channel level
Amenity values may use channel-specific enumeration syntax
The returned amenity set reflects the supplier’s configuration for that channel only

Partners should design their integration logic with the understanding that amenity values are not guaranteed to be identical across channels, even for the same unit.

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

Unit Amenities – Valid Enumeration Values

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

Endpoints Available

Method	Endpoint	Description
GET	v2024.07.31/unit_amenities	Returns amenities for units within the accessible inventory.
GET	v2024.07.31/unit_amenities/{unit_id}	Returns amenities for a single unit within the accessible inventory.

Path Parameters

Path Parameter	Required / Optional	Description
{unit_id}	Required	Unique Identifier for a unit in the inventory.

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown (defaults to 1).	int
page_size	Optional	Limits the number of returned results (defaults to 25).	int
last_unit_update_date	Optional	Only return units that have been modified after the specified date.	date-time
last_reservation_update_date	Optional	Only return units that have received a booking (their own or a calendar sync) after the specified date.	date-time
last_agent_module_property_update_date	Optional	Only return units that have had their agent module property configuration modified after the specified date.	date-time
last_agent_module_agent_update_date	Optional	Only return units that have had their agent module agent configuration modified after the specified date.	date-time
unit_id	Optional	Unique identifier for a unit in the inventory.	int
unit_ids	Optional	Unique identifiers for multiple units within the inventory.	array
management_company_user_id	Optional	Unique identifier for a supplier (management company) associated with returned units.	int
management_company_user_ids	Optional	Unique identifiers for multiple suppliers (management companies).	array
enabled	Optional	Filter results to only units that are enabled or disabled in the current integration context.	boolean
deleted	Optional	Filter results to only show units that are deleted or not deleted.	boolean
display_on_website	Optional	Filter results to only show units that are enabled for the supplier's website.	boolean
allocation_on_arrival	Optional	Return the allocation-on-arrival data when applicable.	boolean
allocation_on_arrival_unit	Optional	Return only units that are the representative unit for their allocation group.	boolean
listing_id	Optional	Lookup a unit by its channel-specific listing identifier.	string
channel	Optional	Restrict 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

Response Definition

Response Item	Description	Data Type
`"unit_amenities"`	Array of unit amenity results. Each item represents a single unit and the amenity classifications currently associated with it.	array
`"paging"`	Paging metadata used to navigate through large result sets when multiple units are returned.	object

`"unit_amenities"` Object

Response Item	Description	Data Type
`"unit_id"`	The unique identifier of the unit these amenities belong to. This matches the `"unit_id"` used across downstream endpoints such as `/unit_calendars`, `/unit_quotes`, and `/reservations`.	int
`"management_company_user_id"`	The unique identifier of the supplier (management company) that manages the unit. This maps directly to the supplier `"id"` returned by `/suppliers` and is commonly used for supplier-scoped grouping and synchronization logic.	int
`"amenities"`	The list of amenity enumeration values currently assigned to the unit. Each entry is a standardized feature classification. Partners should treat this as the authoritative amenity set for display, filtering, and feature tagging logic. Valid amenities values are defined in the Unit Amenities enumeration list. See valid amenities values.	array[string]
`"error"` (Optional)	When present, indicates the unit is returned in the result set but is not fully actionable under the current integration context (for example, supplier-restricted access). The error message should be treated as informational and used to exclude the unit from downstream operational workflows as appropriate.	object

`"error"` Object

Response Item	Description	Data Type
`"message"`	A message describing why the unit is not actionable for the current integration context (for example, deleted, disabled, or not enabled for this Agent). Partners should treat this as an operational state indicator and reference the Error Manual for cause and resolution guidance.	string

`"paging"` Object

Response Item	Description	Data Type
`"next_page_url"`	A URL that can be used to retrieve the next page of supplier results, if additional pages exist.	string
`"previous_page_url"`	A URL that can be used to retrieve the previous page of supplier results, if applicable.	string
`"total_page_count"`	The total number of available pages for the current request.	int
`"page"`	The current page number being returned.	int
`"page_size"`	The number of records being included per page.	int

🚧
If "amenities" is missing, empty, or appears incomplete for a given unit, this does not indicate a technical error. Amenity configuration is supplier-maintained and may vary based on listing setup and channel mappings. Contact the supplier to update listing amenities in CiiRUS.

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
    }
}

Overview

Related Supplier Configuration (Optional Context)

Channel Context (Optional)

Endpoints Available

Path Parameters

Query String Parameters

Response Definition

"unit_amenities" Object

"error" Object

"paging" Object

Sample Request

Sample Response

`"unit_amenities"` Object

`"error"` Object

`"paging"` Object