Search / REST API
Source people
Source people from the best connected workspace prospect database. Pipeline resolves AI Ark, Apollo, GetLeads, Origami, Blitz, Prospeo, Findymail, Icypeas, or another supported provider by capability. Set providerHint only when the operator explicitly requests a provider. Returns canonical people plus provider provenance. Does not create a table or campaign.
POST /api/v1/sourcing/peopleDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
filtersOptional · object- Structured, provider-independent Scout filters.
providerHintOptional · string- Optional connected-provider override. Omit for automatic capability-first resolution.ai_ark · apollo · getleads · origami · blitz · prospeo · findymail · icypeas · crustdata · fullenrich · signalbase · bettercontact · wiza
providerRequestIdOptional · string- BetterContact or Origami request ID from a prior pending response.
providerAnswersOptional · array- Answers to Origami pending questions.
dryRunOptional · boolean- Prepare and redact the initial provider request without fetching data or recording provider spend. Does not test vendor acceptance; later steps may depend on responses.
limitOptional · number- Maximum people to return (1-200, default 25). Use 10 for a campaign pilot.
curl -X POST "https://app.pipeline.help/api/v1/sourcing/people" \
-H "Authorization: Bearer $PIPELINE_API_KEY"Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"filters": {
"type": "object",
"additionalProperties": false,
"properties": {
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"titles": {
"type": "array",
"items": {
"type": "string"
}
},
"seniority": {
"type": "array",
"items": {
"type": "string",
"enum": [
"founder",
"ic",
"senior",
"manager",
"director",
"head",
"vp",
"c_suite"
]
}
},
"geo_countries": {
"type": "array",
"items": {
"type": "string"
}
},
"job_duration_max_months": {
"type": "number"
},
"exclude_titles": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_badges": {
"type": "array",
"items": {
"type": "string"
}
},
"account_keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"product_and_services": {
"type": "array",
"items": {
"type": "string"
},
"description": "Company product/service positioning. AI Ark supports this in people and company search."
},
"account_location": {
"type": "array",
"items": {
"type": "string"
}
},
"industries": {
"type": "array",
"items": {
"type": "string"
}
},
"technologies": {
"type": "array",
"items": {
"type": "string"
}
},
"employee_range": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
},
"funding_stages": {
"type": "array",
"items": {
"type": "string"
}
},
"exclude_domains": {
"type": "array",
"items": {
"type": "string"
}
},
"account_domains": {
"type": "array",
"items": {
"type": "string"
}
},
"department_and_function": {
"type": "array",
"items": {
"type": "string"
}
},
"department_employee_ranges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"function",
"start",
"end"
],
"properties": {
"function": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
},
"timeFrame": {
"type": "string",
"enum": [
"ONE",
"THREE",
"SIX",
"TWELVE",
"TWENTY_FOUR"
]
}
}
},
"description": "Account department headcount, not the selected person title. Verify missing or stale team evidence downstream."
},
"revenue_range": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
},
"company_types": {
"type": "array",
"items": {
"type": "string"
}
},
"website_traffic_range": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
},
"total_funding_range": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
},
"founded_year_range": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
},
"min_linkedin_followers": {
"type": "number",
"minimum": 0
}
},
"description": "Structured, provider-independent Scout filters."
},
"providerHint": {
"type": "string",
"enum": [
"ai_ark",
"apollo",
"getleads",
"origami",
"blitz",
"prospeo",
"findymail",
"icypeas",
"crustdata",
"fullenrich",
"signalbase",
"bettercontact",
"wiza"
],
"description": "Optional connected-provider override. Omit for automatic capability-first resolution."
},
"providerRequestId": {
"type": "string",
"description": "BetterContact or Origami request ID from a prior pending response."
},
"providerAnswers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Answers to Origami pending questions."
},
"dryRun": {
"type": "boolean",
"description": "Prepare and redact the initial provider request without fetching data or recording provider spend. Does not test vendor acceptance; later steps may depend on responses."
},
"limit": {
"type": "number",
"description": "Maximum people to return (1-200, default 25). Use 10 for a campaign pilot."
}
}
}