sdkProvider-backed

Search quickenrich

pipeline.searchQuickenrich

Search connected QuickEnrich company or contact discovery with native documented include/exclude filters. Returns one bounded page with an optional continuation cursor and raw evidence. Company search may incur provider charges; contacts contain availability flags, not emails/phones. country_code and city refer to COMPANY geography; locality is the person location. Use exact public lookup values for country, employee bands, industry, revenue and services. Read provider SOP/docs first. Does not send or enrich.

Parameters

workspaceId
string
No description.
resourcerequired
string
No description.
companies | people
filtersrequired
object
No description.
limit
integer
No description.
cursor
string
No description.

Example

TypeScripttypescript
await pipeline.searchQuickenrich({
"resource": "companies",
"filters": {
"company_name": {
"include": [
"Example company"
]
}
}
})

Response

Success response schemajson schema
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"resource": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object"
}
},
"totalMatching": {
"type": "number"
},
"creditsUsed": {
"type": "number"
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"hasMore": {
"type": "boolean"
},
"raw": {
"type": "object"
},
"sourceUrl": {
"type": "string"
},
"filters": {
"type": "object"
}
}
}
},
"required": [
"success",
"message"
]
}

Exceptions

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