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

Unit Address

Each unit exposes its physical address, both as individual components and as a single pre-formatted string:

• streetAddress1 — Primary street address line (street number and name)
• streetAddress2 — Secondary line (apartment, suite, or building number)
• city — City in which the unit is located
• state — State or province
• zipCode — Postal / ZIP code
• fullAddress — Human-readable address composed from the components above, joined with commas. Blank components are omitted (e.g. a missing streetAddress2 is skipped), and the field is null when the unit has no address information at all.

Unit Availability

Available by Request

The /properties/{propertyId}/availableUnits endpoint lists the units that are currently available for a property, including quoting rent, availability dates, amenities, and floor plan details. The response is wrapped in an envelope with two top-level fields:

• meta — summary information about the result set, including applyNowEnabled, propertyType, and the total count of available units.
• data — the array of available units.

This endpoint always returns the complete set of currently available units for the requested property. Filtering, sorting, field selection, and pagination are not supported.

Available Endpoints