sdkDeterministic

List prospects

pipeline.listProspects

List prospects with optional filtering by campaign, status, or ICP score.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

campaignId

string

No description.

status

string

No description.

icpScoreMin

number

No description.

page

number

No description.

limit

number

No description.

Example

TypeScripttypescript

await pipeline.listProspects({})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspace_id": {
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "full_name": {
            "type": "string"
          },
          "company_name": {
            "type": "string"
          },
          "job_title": {
            "type": "string"
          },
          "linkedin_url": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "icp_score": {
            "type": "number"
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "page": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "total": {
          "type": "number"
        },
        "hasMore": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "data",
    "pagination"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.