API Reference

Units Overview

The Units API provides endpoints for managing and interacting with individual rental units within properties.

Key Concepts

Unit Status

Units can be in various states throughout their lifecycle:

  • VACANT_READY
  • VACANT_NOT_READY
  • OCCUPIED_ON_NTV
  • OCCUPIED_NO_NOTICE
  • DOWN
  • PROPERTY_MODEL
  • PROPERTY_OFFICE
  • NON_PRODUCTIVE

Available Endpoints

EndpointSummaryMethod
/properties/{propertyId}/unitsList all units for a propertyGET
/properties/{propertyId}/units/{unitId}Read UnitGET