Skip to navigation

Amenities Overview

The Amenities API provides endpoints for managing property and unit amenities, including their pricing and availability.

Key Concepts

Amenity Types

Amenities can be categorized by type:

  • UNIT - Amenities specific to individual units
  • FLOOR_PLAN - Amenities associated with floor plans

Amenity Features

  • Fee Structure: Amenities can have associated fees
  • Market Rent Integration: Can be included in market rent calculations
  • Time-based Availability: Support for start and end dates

Available Endpoints

EndpointSummaryMethod
/amenitiesList AmenitiesGET
/amenities/{amenityId}Read AmenityGET