Properties Overview

The Properties API provides endpoints for managing rental properties and their comprehensive information within the property management system.

Key Concepts

Property Information

Properties are the core entity containing:

  • Basic Details: Name, short name, and contact information
  • Physical Address: Complete physical location details
  • Mailing Address: Separate mailing address if different
  • Contact Information: Phone, fax, and email details
  • Geographic Data: Latitude, longitude, and timezone information

Property Management

  • Organization Association: Each property belongs to an organization
  • Timezone Management: Support for different time zones
  • Communication Hub: Central contact point for the property

Property Relationships

Properties serve as the central hub for numerous related entities:

  • Units: Individual rental units within the property
  • Buildings: Physical structures on the property
  • Floor Plans: Available unit layouts and specifications
  • Households: Current and past residents
  • Applications: Rental applications for the property
  • Prospects: Potential tenants interested in the property
  • Leases: Active and historical lease agreements
  • Work Orders: Maintenance and service requests
  • Amenities: Property and unit amenities
  • Financial Records: Deposits, transactions, and GL entries
  • Reports: Property-specific reporting and analytics

Available Endpoints

EndpointSummaryMethod
/propertiesList PropertiesGET
/properties/{propertyId}Read PropertyGET
/propertyGroupsList Property GroupsGET
/propertyGroupsCreate Property GroupPOST
/propertyGroups/{propertyGroupId}Read Property GroupGET
/propertyGroups/{propertyGroupId}Update Property GroupPUT
/propertyGroups/{propertyGroupId}Delete Property GroupDELETE