Sign in

v6

OpenAPI 3.1.02026-08-0331136162.2 KB
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

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

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",
  "buildings": [
    {
      "id": "501",
      "name": "Tower A",
      "address": {
        "street_address": "125 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      }
    }
  ]
}