Overview

The Retrieve Unit Amenities request is designed to offer the Agent a way to access comprehensive information about the amenities associated with units within the available Inventory. This endpoint allows API Users to retrieve the amenities available for a specific unit or entire inventories.

Endpoints Available

Method	Endpoint	Description
GET	v2024.07.31/unit_amenities	Returns amenities for units in the inventory.
GET	v2024.07.31/unit_amenities/{unit_id}	Returns amenities for a specified unit in the 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 of units.	int
management_company_user_ids	Optional	Unique Identifiers for multiple suppliers of units.	array
enabled	Optional	Use only enabled or disabled units.	boolean
deleted	Optional	Only show properties that are deleted or not deleted.	boolean
display_on_website	Optional	Only show properties that are enabled for the management company's website.	boolean
allocation_on_arrival	Optional	Return the allocation on arrival object.	boolean
allocation_on_arrival_unit	Optional	Return units that are the representative unit in their group.	boolean
channel	Optional	Leave empty for general, "all" for all amenities, "airbnb" for Airbnb specific amenities, "vrbo" for Vrbo's specific amenities list, or "bdc" for Booking.com's amenities, if configured for the unit.	string

Response Definition

Response Item	Description	Data 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 Item	Description	Data 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
    }
}