Property

A real estate property asset.

createdUtc
Type: stringFormat: date-time
required

Creation timestamp (UTC).
etag
Type: string
required

ETag for concurrency control.
id
Type: string
required

Property ID.
name
Type: string
required

Property name.
updatedUtc
Type: stringFormat: date-time
required

Last update timestamp (UTC).
avgContractLengthYears
Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

Average contract length in years.
categories
Type: array object[] · PropertyCategory[]

Asset categories with yield, rental income, and area data.
Property category with yield, rental income, and area data.
- type
  Type: string
  required
  
  Asset type with optional sub-type: "office", "retail/shopping_mall", "industrial/warehouse", etc.
- conversions
  Type: array string[] | null
  
  Potential conversion categories: residential, office, retail, industrial, hotel, etc. Uses the same values as the category field.
- locationClass
  Type: null | string
  
  Location class: "A", "B", "C" (micro-location quality rating).
- rentalIncome
  Type: object · Price nullable
  
  Annual rental income.
- rentedArea
  Type: object · Area nullable
  
  Total rented floor area.
- vacantArea
  Type: object · Area nullable
  
  Total vacant floor area.
- yieldPercent
  Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  
  Yield percentage.
changeOrigin
Type: null | string

Origin channel that triggered this change.
changeType
Type: null | string

Type of change that produced this version: "create", "update", or "delete".
deletedUtc
Type: null | stringFormat: date-time

Deletion timestamp (UTC) if soft-deleted.
description
Type: null | string

Free-text property description (asset summary, investment thesis, or notes).
distance_meters
Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double

Distance from the search origin in meters. Only included when the request specifies a spatial origin (near, location, or sort_origin).
externalRefs
Type: array object[] | null · ExternalRef[]

External system references (e.g., Yardi, Salesforce).
Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.
- id
  Type: string
  max length:
  255
  required
  
  External identifier within the namespace (e.g., "003XXXXXXXXXXXX" for Salesforce). Case-sensitive. Format depends on the external system.
- namespace
  Type: string
  max length:
  50
  required
  
  External system namespace (e.g., "salesforce", "hubspot", "pipedrive", "csv-import"). Case-insensitive.
location
Type: object · PropertyLocation nullable

Property location with coordinates, country, and locality.
- country
  Type: null | string
  
  ISO 3166-1 alpha-2 country code.
- latitude
  Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
  
  WGS84 latitude.
- locality
  Type: null | string
  
  City or area name.
- longitude
  Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
  
  WGS84 longitude.
operatingCosts
Type: object · Price nullable

Annual operating costs (e.g., maintenance, insurance, property tax).
- currency
  Type: string
  min length:
  3
  max length:
  3
  required
  
  ISO 4217 currency code (e.g., "SEK", "EUR", "USD").
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  min:
  0
  required
  
  Price value. Multiply by scale factor to get actual amount. Example: value=1500 with scale="millions" = 1.5 billion.
- scale
  Type: string
  
  Scale factor for the value: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.
parcelArea
Type: object · Area nullable

Parcel area.
- unit
  Type: string
  required
  
  Area unit. Write requests must include "sqm"; read responses are normalized to "sqm".
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  required
  
  Area value.
price
Type: object · Price nullable

Asking price.
- currency
  Type: string
  min length:
  3
  max length:
  3
  required
  
  ISO 4217 currency code (e.g., "SEK", "EUR", "USD").
- value
  Type: number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
  min:
  0
  required
  
  Price value. Multiply by scale factor to get actual amount. Example: value=1500 with scale="millions" = 1.5 billion.
- scale
  Type: string
  
  Scale factor for the value: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.
projects
Type: array object[] | null · PropertyProjectRef[]

Linked projects.
Reference to a linked project.
- id
  Type: string
  required
  
  Project ID.
- name
  Type: string
  required
  
  Project name.
- uri
  Type: null | string
  
  Opaque canonical Propstreet entity URI for deep linking.
tags
Type: array string[] | null

Property tags using documented snake_case values.
tenure
Type: null | string

Property tenure: "freehold" or "leasehold".
uri
Type: null | string

Opaque canonical Propstreet entity URI for deep linking.
yearBuilt
Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

Year built.
zoning
Type: object · Zoning nullable

Zoning information: permitted gross floor area and zoning categories.
- categories
  Type: array string[] | null
  
  Zoning categories: residential, office, retail, industrial, hotel, etc. Uses the same values as the property category field.
- gfa
  Type: object · Area nullable
  
  Permitted gross floor area (GFA).