Overview

The Retrieve Amenities request is designed to offer the Agent a streamlined way to access comprehensive information about 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	v2023.07.31/content/amenities	Returns amenities for Inventory
GET	v2023.07.31/content/amenities/{unitId}	Returns amenities for a Unit in Inventory

Path Parameters

Path Parameter	Required / Optional	Description
{unitId}	Required	Unique Identifier for Unit in Inventory

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown	int
pageSize	Optional	Limits the number of returned results	int
lastUpdateDate	Optional	Only returns objects which have been modified after a certain date	date-time
mcUserId	Optional	Unique Identifier for Supplier	int
mcUserIds	Optional	Unique Identifiers for Suppliers	array
unitId	Optional	Unique Identifier for Unit in Inventory	int
UnitIds	Optional	Unique Identifiers for Units in Inventory	array
channel	Optional	leave empty for general, "airbnb" for airbnb, "vrbo" for vrbo, and "bdc" for bdc	string

Response Definition

Response Item	Description	Data Type
`"unit_id"`	Unique identifier for the rental unit associated with the listed amenities	int
`"amenities"`	A list of amenities available for the Unit. Each element in the array represents a specific amenity provided by the Unit	array
`"error_message"`*	This is a message indicating an issue with the Unit (If applicable)	string
`"error_code"`*	The error code associated with the specific error message (If applicable)	int

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/content/amenities'

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/content/amenities/219264?channel=vrbo'

Sample Response

{
    "unit_id": 219264,
    "amenities": [
        "CommunalPool",
        "Pool",
        "Spa",
        "OutDoorHotTub",
        "IndoorHotTub",
        "FreeSolarHeatedPool",
        "PrivatePoolHeatable",
        "SouthFacingPool",
        "PoolAccess",
        "IndoorJacuzzi",
        "Bbq",
        "Grill",
        "HairDryer",
        "PartialKitchen",
        "Dishwasher",
        "MiniKitchen",
        "FullKitchen",
        "ResortAmenities",
        "Elevator",
        "WheelChairAccessible",
        "FreeCalls",
        "PavedParking",
        "RockingChairs",
        "Microwave",
        "LaundryInUnit",
        "LaundryOnSite",
        "UnitAmenities",
        "Dock",
        "MotorCycle",
        "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",
        "GolfIncluded",
        "BigScreenTv",
        "TvInEveryBedroom",
        "CdPlayer",
        "DvdPlayer",
        "Fishing",
        "ClubHouse",
        "TennisCourts",
        "PetsAllowed",
        "PrivacyFence",
        "BeachOnSite"
    ]
    "error_message": "Property has been deleted. Property supplier has not enabled this property.",
    "error_code": 401
		},
		...
	],
	"next_page_url": "https://api.ciiruspartners.com/v20230731/content/amenities?page=2&pageSize=25",
	"total_page_count": 3
}