PagedResponseOfOffer

Paginated response with cursor-based pagination.

  • data
    Type: array object[] · Offer[]
    required

    The list of data items for this page.

    One row from the caller's visible offer inbox. Which optional fields are populated depends on the row category and status: unanswered buying offers expose only the anonymized teaser and response deadline; pending invitation rows expose an envelope without teaser content; accepted lifecycle rows can expose broker contact details and available capabilities.

    • category
      Type: string
      required

      Inbox category: "buying" for broker-shared investment opportunities, "invitation" for pending Case Room or Seller Portal invitations, or "selling" for accepted Seller Portal offers where the caller is the seller.

    • id
      Type: string
      required

      Unique offer identifier.

    • status
      Type: string
      required

      Offer state. Buying offers can be "unanswered", "accepted", "rejected", "expired", "removed", or "closed". Invitation offers are "pending". Selling offers can be "accepted", "removed", or "closed".

    • uri
      Type: string
      required

      Opaque canonical Propstreet entity URI for deep linking.

    • acceptedUtc
      Type: null | stringFormat: date-time

      When the caller accepted the teaser or invitation (UTC).

    • acceptMessage
      Type: null | string

      Free-form message the caller included with their acceptance.

    • broker
      Type: object · OfferBroker nullable

      Broker contact. Populated for accepted and established offers; null otherwise.

    • capabilities
      Type: array string[]

      Capability flags indicating what actions are available for this offer. Possible values: chat (messaging with the broker is available).

    • communicatedUtc
      Type: null | stringFormat: date-time

      When the teaser or invitation was first delivered to the caller (UTC).

    • deadlineUtc
      Type: null | stringFormat: date-time

      Deadline for the caller to respond (UTC).

    • teaser
      Type: object · InvestorTeaser nullable

      Anonymized teaser content (asset mix, price/yield/area ranges, zoning, tags).

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

Propstreet Documentation