Lists prospects for a project. Returns all prospects for the project, including those communicated a teaser and those removed from your list (status removed); filter with status to narrow it.
Path Parameters
- Type: stringproject
Id requiredProject ID
Query Parameters
- Type: stringFormat: date-timeupdated
_since Filter prospects updated on or after this UTC timestamp (ISO 8601). Includes created, modified, and deleted prospects.
- Type: booleaninclude
_deleted Also list prospects deleted with DELETE (status deleted). Removed prospects (status removed) are listed without it.
- Type: integer | stringFormat: int32page
_size Number of prospects per page (1-500, default 500)
- Type: stringcursor
Opaque cursor token from previous response for pagination
- Type: stringcapability
Optional actionability filter; omit for listing or ranking. chat = only prospects you can message right now (an established Case Room, open when the project's organisation or the buyer's organisation is on the Professional plan). Most shortlists have few or zero such prospects, and a shortlist with no Case Room established yet returns an empty list. To browse the full shortlist, leave this unset and read each prospect's capabilities array. Pairing it with stage=not_contacted (or classification=not_contacted) returns an empty list, since an established Case Room means the prospect is past "not contacted". (Pairing with any later stage is fine — a prospect who has been sent the teaser can have an established room.)
- Type: stringinterest
Filter by the broker's interest judgement: interested, maybe, not_interested, or none for prospects without one
- Type: stringstage
Filter by process stage: not_contacted, teaser, im, data_room, bid
- Type: stringclassificationdeprecated
Deprecated: filter by the legacy single-value classification (not_contacted, contacted, interested, not_interested, bidder), which interest and stage writes do not update. Filter by interest and stage instead.
- Type: array of string
Filter by the contact's or company's network-wide tags (OR semantics). Repeat the query parameter to pass multiple tags.
- Type: stringtask
_due Filter to prospects with an open follow-up task due in a window: overdue (due instant has passed), today (UTC day), this_week (today through the next six days)
- Type: array of string
Filter by your labels on the prospect within this project (projectTags; OR semantics, case-insensitive). Repeat the query parameter to pass multiple tags.
- Type: stringstatus
Filter by where the prospect stands: active, declined, closed or removed. closed includes a prospect the buyer declined after you established contact (closed or withdrew on their side; investorDeclinedUtc is set). Omit to list every status.
Responses
- application/json
- application/problem+json
- application/problem+json
- application/problem+json
curl 'https://app.propstreet.com/api/v1/projects/{projectId}/prospects?include_deleted=false' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"data": [
{
"id": "string",
"uri": null,
"externalRefs": [
{
"namespace": "string",
"id": "string"
}
],
"projectId": "string",
"contactId": null,
"companyId": null,
"contacts": [
{
"contactId": "string",
"isMain": true,
"addedUtc": "2026-11-11T23:30:59.686Z"
}
],
"buyerGroupId": "string",
"identityHidden": true,
"memberNumber": null,
"displayName": null,
"organizationName": null,
"status": "active",
"investorDeclinedUtc": null,
"interest": "interested",
"stage": "not_contacted",
"stageOverride": {
"stage": "not_contacted",
"setBy": {
"id": "string",
"name": "string"
},
"setAtUtc": "2026-11-11T23:30:59.686Z",
"reason": null
},
"nextTask": {
"id": "string",
"type": "call",
"dueDateUtc": "2026-11-11T23:30:59.686Z",
"assignee": {
"id": "string",
"name": "string"
},
"overdue": true
},
"openTaskCount": 1,
"classification": null,
"owner": {
"id": "string",
"name": "string"
},
"capabilities": [
"string"
],
"tags": [
"string"
],
"projectTags": [
"string"
],
"teaser": {
"acceptedUtc": null,
"deadlineUtc": null
},
"createdUtc": "2026-11-11T23:30:59.687Z",
"updatedUtc": "2026-11-11T23:30:59.687Z",
"deletedUtc": null,
"etag": "string",
"outcome": "created",
"possibleDuplicates": [
{
"id": "string",
"kind": "contact",
"name": "string",
"companyName": null,
"phone": null,
"tier": "identity",
"reasons": [
{
"reason": "email",
"tier": "identity",
"matched": null
}
],
"prospectId": null,
"prospectRemoved": null,
"inRequest": null
}
],
"changeType": null,
"changeOrigin": null
}
],
"page": {
"nextCursor": null,
"pageSize": 1,
"hasMore": true
}
}