Floor Plans Overview

The Floor Plans API provides endpoints for managing unit floor plan templates and their specifications within properties.

Key Concepts

Floor Plan Specifications

Floor plans define the template structure for units:

  • Layout Details: Number of bedrooms, bathrooms, and half-bathrooms
  • Space Measurements: Gross and rentable square footage
  • Housing Types: Support for affordable and commercial units
  • Property Association: Each floor plan belongs to a specific property

Rental Information

  • Market Rent: Base market rent amount for the floor plan
  • Quoting Rent: Current rent amount used for quotes
  • Financial Market Rent: Rent amount used for financial calculations
  • Marketing Details: Marketing name and description for listings

Floor Plan Relationships

  • Units: Multiple units can use the same floor plan template
  • Amenities: Associated amenities available for this floor plan type
  • Listings: Connected to rental listings and marketing materials
  • Property Integration: Part of larger property management structure

Available Endpoints

EndpointSummaryMethod
/floorPlansList Floor PlansGET
/floorPlans/{floorPlanId}Read Floor PlanGET