Project

A real estate transaction project.

  • asset
    Type: object · Asset
    required

    Asset information: single property or portfolio with property count.

    • type
      Type: string
      required

      Asset type: "single" for single property, "portfolio" for multiple properties.

    • propertyCount
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Number of properties in the portfolio. Only present when type is "portfolio".

  • createdUtc
    Type: stringFormat: date-time
    required

    Creation timestamp (UTC).

  • etag
    Type: string
    required

    ETag for concurrency control.

  • id
    Type: string
    required

    Project ID.

  • name
    Type: string
    required

    Project name.

  • status
    Type: string
    required

    Project lifecycle status: open, closed, deleted.

  • updatedUtc
    Type: stringFormat: date-time
    required

    Last update timestamp (UTC).

  • changeOrigin
    Type: null | string

    Origin channel that triggered this change. Informational only; treat as an opaque value.

  • changeType
    Type: null | string

    Type of change that produced this version: "create", "update", or "delete"

  • classification
    Type: null | string

    Project classification (work stage): draft, active, inactive. Defaults to "draft" when no explicit classification has been set.

  • deletedUtc
    Type: null | stringFormat: date-time

    Deletion timestamp (UTC) if soft-deleted.

  • externalRefs
    Type: array object[] · ExternalRef[]

    External references for CRM integration (e.g., Salesforce, HubSpot).

    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.

  • mandate
    Type: null | string

    Sales mandate type: "exclusive", "non_exclusive", "other", or null if not set.

  • price
    Type: object · Price nullable

    Asking price / price expectation for the deal (single value).

    • 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.

  • priceRange
    Type: object · PriceRange nullable

    Custom price range (min/max override for display purposes).

    • currency
      Type: string
      min length:  
      3
      max length:  
      3
      required

      ISO 4217 currency code (e.g., "EUR", "SEK", "USD").

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum price. Multiply by scale factor to get actual amount. Example: max=200 with scale="millions" = 200 million.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum price. Multiply by scale factor to get actual amount. Example: min=100 with scale="millions" = 100 million.

    • scale
      Type: string

      Scale factor for the values: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.

  • properties
    Type: array object[] | null · ProjectPropertyRef[]

    Linked properties. Currently contains at most one property.

    Reference to a linked property.

    • id
      Type: string
      required

      Property ID.

    • name
      Type: string
      required

      Property name.

    • uri
      Type: null | string

      Opaque canonical Propstreet entity URI for deep linking.

  • teaser
    Type: object · Teaser nullable

    Teaser information including workflow stage and timestamps. Null if teaser workflow has not started.

    • communicatedUtc
      Type: null | stringFormat: date-time

      When the teaser was first communicated to prospects (UTC). Null if not yet communicated.

    • publishedUtc
      Type: null | stringFormat: date-time

      When the teaser was published (UTC). Null if not yet published.

    • stage
      Type: null | string

      Teaser workflow stage: property_added, drafting, published, verified, communicated. Null if teaser workflow has not started.

    • verifiedUtc
      Type: null | stringFormat: date-time

      When the teaser was verified (UTC). Null if not yet verified.

  • transactions
    Type: array object[] | null · Transaction[]

    Completed transactions (populated when status="closed").

    Transaction record for a closed deal.

    • closedUtc
      Type: stringFormat: date-time
      required

      When the deal closed (ISO 8601 UTC).

    • type
      Type: string
      required

      Transaction type: "sell" (future: "buy").

    • buyer
      Type: object · TransactionParty nullable

      Buyer details (populated for sell transactions).

    • price
      Type: object · PriceRange nullable

      Transaction price.

    • seller
      Type: object · TransactionParty nullable

      Seller details (populated for buy transactions).

    • yield
      Type: object · PercentRange nullable

      Yield at transaction.

  • uri
    Type: null | string

    Opaque canonical Propstreet entity URI for deep linking.

Propstreet API Documentation