Prospect

A prospect (investor) associated with a project.

  • createdUtc
    Type: stringFormat: date-time
    required

    Best available creation timestamp (UTC). For prospects without a teaser, this is when added to the project. For communicated prospects, this is when the prospect was created.

  • etag
    Type: string
    required

    ETag for concurrency control.

  • id
    Type: string
    required

    Unique prospect identifier.

  • projectId
    Type: string
    required

    Parent project ID.

  • updatedUtc
    Type: stringFormat: date-time
    required

    Last update timestamp (UTC).

  • capabilities
    Type: array string[]

    Capability flags indicating what actions are available for this prospect. Possible values: chat (messaging available).

  • 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

    Prospect classification indicating pipeline stage. Values: not_contacted, contacted, interested, not_interested, bidder. Defaults to "not_contacted" for newly created prospects. Can be updated via PATCH.

  • companyId
    Type: null | string

    Company ID if prospect is linked to a company. Prefer contactId when the person is known — use companyId only as a placeholder until you identify the specific contact. In responses, both contactId and companyId may be set if the contact works at a company. In create requests, provide exactly one of contactId or companyId (mutually exclusive).

  • contactId
    Type: null | string

    Contact ID if prospect is linked to a contact. In responses, both contactId and companyId may be set if the contact works at a company. In create requests, provide exactly one of contactId or companyId (mutually exclusive).

  • deletedUtc
    Type: null | stringFormat: date-time

    Deletion timestamp (UTC) if the prospect was removed.

  • displayName
    Type: null | string

    Human-readable investor label for lists and review screens.

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

  • organizationName
    Type: null | string

    Organization label when the prospect is a person linked to a company.

  • tags
    Type: array string[]

    Tags associated with this prospect's contact or company.

  • teaser
    Type: object · ProspectTeaser nullable

    Teaser information including acceptance and deadline timestamps. Only populated for communicated prospects (those who received the teaser). Null for prospects that have not been communicated a teaser.

    • acceptedUtc
      Type: null | stringFormat: date-time

      When the investor accepted the teaser (UTC). Null if not yet accepted.

    • deadlineUtc
      Type: null | stringFormat: date-time

      Deadline for investor response (UTC). Null if no deadline set.

  • uri
    Type: null | string

    Opaque canonical Propstreet entity URI for deep linking.

Propstreet API Documentation