sdkDeterministic

Get prospect

pipeline.getProspect

Get the full prospect record: profile, company, ICP score + analysis, enrichments, agentExecutions (research/scoring/messaging history), conversion stage, conversation activity, and prospect_lists membership. Use this when you need everything about one prospect - for partial views (just profile or just stage), use the more specific tools.

Parameters

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

Example

TypeScripttypescript
await pipeline.getProspect({
"prospectId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema
{
"type": "object",
"properties": {
"prospect": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profile": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"fullName": {
"type": "string"
},
"jobTitle": {
"type": "string"
},
"companyName": {
"type": "string"
},
"location": {
"type": "string"
},
"linkedinUrl": {
"type": "string"
}
}
},
"company": {
"type": "object"
},
"customFields": {
"type": "object"
},
"workflow_data": {
"type": "object"
}
}
},
"enrichments": {
"type": "object"
},
"_raw": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspace_id": {
"type": "string"
},
"prospect_list_id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
},
"required": [
"prospect"
]
}

Exceptions

PipelineError
Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.
Pipeline TypeScript SDK documentation | Pipeline