Skip to Content
DocumentationQuickstart

Searches quickstart

Use Searches to find companies and people using filters. Searching for companies & people is often called “prospecting”, “list building” or “sourcing”.

With searches, you combine and deduplicate datasets from multiple providers. The search catalog lists all available datasets.

Making requests

This request fetches a list of companies using the people:profiles:icypeas@1 dataset.

const result = await fetch("https://api.pipe0.com/v1/searches/run", { method: "POST", headers: { "Authorization": `Bearer ${API_KEY}`, "Content-Type": "application/json" }, body: JSON.stringify({ config: { environment: "production", dedup: { strategy: "default" } }, searches: [ { search_id: "people:profiles:icypeas@1", config: { limit: 100, filters: { industry: { include: ["Software Development"] } } } }, ], }) });

You can find the list of available filters per dataset in the search catalog .

Append additional searches to the searches property to combine multiple searches in one request.

Poll the result

The request to https://api.pipe0.com/v1/searches/run creates a search task. Poll the task until its status is marked as completed. Use the following endpoint for polling (recommended intervall: 1s):

GET https://api.pipe0.com/v1/searches/run

Work with the response

The result will look something like this:

{ "results": [ { "name": { "value": "Gayle Pouros", "type": "string", "format": "text", "status": "completed" "ui": {}, }, "job_title": { "value": "Product Intranet Manager", "type": "string", "format": "text", "status": "completed", "ui": {}, }, ... }, ... ] }

The result of a search can be the input for a pipes request (enrichment). Under the hood, this uses input expansion.

Last updated on