PagedResponseOfProperty

Paginated response with cursor-based pagination.

data
Type: array object[] · Property[]
required

The list of data items for this page.
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.
- 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.
- location
  Type: object · PropertyLocation nullable
  
  Property location with coordinates, country, and locality.
- operatingCosts
  Type: object · Price nullable
  
  Annual operating costs (e.g., maintenance, insurance, property tax).
- parcelArea
  Type: object · Area nullable
  
  Parcel area.
- price
  Type: object · Price nullable
  
  Asking price.
- projects
  Type: array object[] | null · PropertyProjectRef[]
  
  Linked projects.
  
  Reference to a linked project.
- 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.
page
Type: object · PageInfo
required

Pagination metadata.
- hasMore
  Type: boolean
  required
  
  True if there are more results available after this page.
- pageSize
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  required
  
  Number of items requested per page.
- nextCursor
  Type: null | string
  
  Opaque cursor string to fetch the next page of results. Null if there are no more results.