Lists prospects for a project. Returns all prospects for the project, including those communicated a teaser.

​
Path Parameters
  • projectId
    Type: string
    required

    Project ID

Query Parameters
  • updated_since
    Type: string Format: date-time

    Filter prospects updated on or after this UTC timestamp (ISO 8601). Includes created, modified, and deleted prospects.

  • include_deleted
    Type: boolean

    Include deleted prospects in results

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

    Number of prospects per page (1-500, default 500)

  • cursor
    Type: string

    Opaque cursor token from previous response for pagination

  • capability
    Type: string

    Optional actionability filter; omit for listing or ranking. chat = only prospects you can message right now (an established Case Room on a Professional-plan project). 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 classification=not_contacted returns an empty list, since an established Case Room means the prospect is past "not contacted". (Pairing with classification=contacted is fine — a contacted prospect can have an established room.)

  • classification
    Type: string

    Filter by classification: not_contacted, contacted, interested, not_interested, bidder

  • tags
    Type: array string[]

    Filter by tags (OR semantics). Repeat the query parameter to pass multiple tags.

Responses
  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/api/v1/projects/{projectId}/prospects
curl 'https://app.propstreet.com/api/v1/projects/{projectId}/prospects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "string",
      "uri": null,
      "externalRefs": [
        {
          "namespace": "string",
          "id": "string"
        }
      ],
      "projectId": "string",
      "contactId": null,
      "companyId": null,
      "displayName": null,
      "organizationName": null,
      "classification": null,
      "owner": {
        "id": "string",
        "name": "string"
      },
      "capabilities": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "teaser": {
        "acceptedUtc": null,
        "deadlineUtc": null
      },
      "createdUtc": "2026-08-13T21:32:28.852Z",
      "updatedUtc": "2026-08-13T21:32:28.852Z",
      "deletedUtc": null,
      "etag": "string",
      "changeType": null,
      "changeOrigin": null
    }
  ],
  "page": {
    "nextCursor": null,
    "pageSize": 1,
    "hasMore": true
  }
}

OK

Propstreet Documentation