SearchResponseOfMandate

Response from a search operation with pagination metadata.

  • hasMore
    Type: boolean

    Whether there are more results available beyond this page. True if (offset + limit) < total.

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

    The limit used for this page (echoed from request). Useful for constructing next page requests.

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

    The offset used for this page (echoed from request). Useful for constructing next page requests.

  • results
    Type: array object[] · Mandate[]

    The search results for this page.

    Investor mandate: investor-side acquisition criteria. Describes what an investor is looking to buy (price range, geographic area, asset types, tags).

    • createdUtc
      Type: stringFormat: date-time
      required

      Creation timestamp (UTC).

    • etag
      Type: string
      required

      ETag for concurrency control.

    • id
      Type: string
      required

      Mandate ID.

    • name
      Type: string
      required

      Mandate name.

    • updatedUtc
      Type: stringFormat: date-time
      required

      Last update timestamp (UTC).

    • categories
      Type: array object[] · MandateCategory[]

      Asset categories with category-specific criteria.

      Category within a mandate with category-specific criteria.

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

    • country
      Type: null | string

      ISO 3166-1 alpha-2 country code for the primary target country.

    • deletedUtc
      Type: null | stringFormat: date-time

      Deletion timestamp (UTC) if the resource has been deleted.

    • description
      Type: null | string

      Free-text investment strategy / thesis.

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

      External system references for CRM integration. Each namespace can only appear once.

      Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.

    • geography

      GeoJSON Polygon/MultiPolygon representing the target acquisition area. Coordinates are [longitude, latitude] (WGS84).

    • investmentSize
      Type: object · PriceRange nullable

      Investment size range.

    • negativeTags
      Type: array string[] | null

      Negative tags (excluded attributes). Mutually exclusive with positiveTags per tag.

    • parcelArea
      Type: object · AreaRange nullable

      Parcel area range.

    • positiveTags
      Type: array string[] | null

      Positive tags (required attributes). Mutually exclusive with negativeTags per tag.

    • resolvedLocation
      Type: object · MandateResolvedLocation nullable

      Location resolved from a named location on write (e.g., "Stockholm"). Write-response only — always null on GET.

    • uri
      Type: null | string

      Opaque canonical Propstreet entity URI for deep linking.

    • yearBuilt
      Type: object · YearRange nullable

      Year built range (e.g., 1990-2010).

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

    Total number of results matching the search criteria (before pagination). Useful for displaying "Showing 1-100 of 247 results" in UIs.

Propstreet API Documentation