Properties v2

Retrieve a property

Retrieves comprehensive details for a specific property.

Returns full property information including address, property type, status, total units, and external system identifiers. Use this to get complete property context before making other API calls.

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

get/v2/properties/{property_id}

Path parameters

property_idstring required

The property ID

Response

Successful Response

idstring required

Unique identifier for the property

namestring required

Property name for display

property_type'multi_family' | 'single_family' | 'other' required

Types of properties managed in the system

status'active' | 'inactive' required

Current operational status of the property

total_unitsinteger

Total number of units in the property

organization_idstring

Organization ID for the property. Denotes who manages the property

organization_namestring

Organization name for the property

has_phasesboolean

Whether the entities list contains a SUB_PROPERTY entity

Example response

{
  "id": "12345",
  "name": "Sunrise Apartments",
  "property_type": "multi_family",
  "status": "active",
  "address": {
    "street_address": "123 Main Street",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  },
  "total_units": 250,
  "external_ids": [
    {
      "source": "YardiVoyager",
      "id_type": "property",
      "external_id": "12345"
    }
  ],
  "organization_id": "6789",
  "organization_name": "Sunrise Residential",
  "has_phases": true,
  "entities": [
    {
      "id": "018e2b7e-becf-7000-8000-00000000000f",
      "name": "Sunrise Apartments",
      "type": "PROPERTY",
      "building_ids": []
    },
    {
      "id": "018e2b7e-becf-7000-8000-00000000000a",
      "name": "Phase A",
      "type": "SUB_PROPERTY",
      "building_ids": [
        "501"
      ]
    }
  ],
  "buildings": [
    {
      "id": "501",
      "name": "Tower A",
      "address": {
        "street_address": "125 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      }
    }
  ]
}

Changes

Changed in 2 of the 25 revisions of this API.4

Aug 11, 2026b4ebf60d6d891See the full diff
- ○
  added the optional property organization_name to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 2026ce0a43017b093See the full diff
- ○
  added the non-success response with the status 503
  response-non-success-status-added
- ○
  added the optional property entities to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property has_phases to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history