Sign in

v6

OpenAPI 3.1.02026-08-0331136162.2 KB
Units v2

Retrieve a unit

Retrieves comprehensive details for a specific unit.

Returns full unit information including address, physical characteristics, floor plan details, pricing, and availability information.

Unit IDs: Unit IDs are permanent and unique across the system. Use the same ID format returned from the list units endpoint.

get/v2/properties/{property_id}/units/{unit_id}

Path parameters

property_idstring required

The property ID

The property ID

unit_idstring required

The unit ID (numeric)

The unit ID (numeric)

Response

Successful Response

idstring required

Unique identifier for the unit

property_idstring required

ID of the property this unit belongs to

unit_numberstring required

Unit number for display and mail delivery

building_idstring

ID of the building this unit belongs to (matches buildings[].id on GET /v2/properties/{property_id}); null when not scoped to a building

bedroomsinteger required

Number of bedrooms

bathroomsnumber required

Number of bathrooms

square_feetinteger

Unit square footage

floorinteger

Floor number (ground floor = 1)

building_namestring

Building name or identifier

floor_planstring

Name of the floor plan

floor_plan_idstring

ID of the associated floor plan

unit_leasing_status'available' | 'application_hold' | 'leased' | 'on_notice' | 'not_available' | 'notice_application_hold' | 'notice_leased'

An enumeration.

unit_status'ready' | 'renovating' | 'make_ready' | 'occupied' | 'model' | 'offline'

An enumeration.

available_datestring date

Date unit becomes available

market_rentnumber

Market rent amount (not meant for display on websites)

asking_rentnumber

Current lowest marketed offer on the unit

created_atstring date-time required

When this unit was created

updated_atstring date-time required

When this unit was last modified

Example response

{
  "building_id": "501",
  "address": {
    "street_address": "123 Main Street",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  }
}