Prospect
A prospect (investor) associated with a project.
- createdType: stringFormat: date-time
Utc requiredBest 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.
- etagType: stringrequired
ETag for concurrency control.
- idType: stringrequired
Unique prospect identifier.
- openType: integer | stringFormat: int32
Task Count requiredHow many open follow-up tasks the prospect carries.
- projectType: string
Id requiredParent project ID.
- stageType: enumrequired
How far the prospect has come in the process, derived from what has actually happened (teaser sent, NDA signed, Case Room access, bid registered): not_contacted, teaser, im, data_room, bid. Never lowered by later events; a manual correction via PATCH (stage) is recorded as
stageOverride.valuesnot_contactedteaserimdata_roombid - statusType: enumrequired
Where the prospect stands on your list. When several apply, the strongest wins: deleted over removed, removed over closed, closed over declined, declined over active (so a deleted prospect reads deleted whatever else is true). A removed prospect left your list with its history kept: it still takes notes, refuses every other change, and comes back with POST ./restore (or by adding the same contact or company again). Deleted prospects are listed only with
include_deleted=true. Filter the list withstatus=.valuesactivedeclinedclosedremoveddeleted - updatedType: stringFormat: date-time
Utc requiredLast update timestamp (UTC).
- capabilitiesType: array of string
Capability flags indicating what actions are available for this prospect. Possible values: chat (messaging available).
- changeType: null | string
Origin Origin channel that triggered this change. Informational only; treat as an opaque value.
- changeType: null | string
Type Type of change that produced this version: "create", "update", or "delete"
- classificationType: null | stringdeprecated
Deprecated: the legacy single-value classification (not_contacted, contacted, interested, not_interested, bidder), kept for existing integrations. It reports only the last classification written through this field and is not updated by interest or stage writes, so it can disagree with them. Read
interestandstageinstead. - companyType: null | string
Id 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).
- contactType: null | string
Id 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).
- deletedType: null | stringFormat: date-time
Utc Deletion timestamp (UTC) if the prospect was removed.
- displayType: null | string
Name Human-readable investor label for lists and review screens.
- externalType:
Refs Properties: 2External references for CRM integration (e.g., Salesforce, HubSpot).
- interestType: enumnullable
The broker's judgement of the prospect's appetite: interested, maybe, not_interested. Null when no judgement has been recorded (or it was cleared). Independent of
stage— a prospect can be interested before any outreach, or not interested deep into the process. Set or clear via PATCH (interest).valuesinterestedmaybenot_interested - nextType: nullable
Task Properties: 5The nearest-due open follow-up task (call, meeting or email with a due date and an optional assignee). Omitted when the prospect has no open task. Add tasks via POST ./tasks and close them via POST ./tasks/{taskId}/complete.
- organizationType: null | string
Name Organization label when the prospect is a person linked to a company.
- ownerType: nullableProperties: 2
The team member assigned as this prospect's owner, if any. Assign or unassign via PATCH (owner).
- projectType: array of string
Tags Your own labels on this prospect within this project — for example "Single tenant" or "Follow up Q4". They live on the prospect, not on the contact or company, so they never show on the same investor in another project. Replace via PATCH (projectTags); filter the list with
project_tags=. Never shown to the investor. - stageType: nullable
Override Properties: 4The latest manual stage correction, with who set it, when, and the reason given. Omitted when the stage has never been overridden.
- tagsType: array of string
Tags associated with this prospect's contact or company — network-wide labels that follow the contact or company into every project. For labels on this prospect within this project only, see
projectTags. - teaserType: nullableProperties: 2
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.
- uriType: null | string
Opaque canonical Propstreet entity URI for deep linking.