Skip to main content
POST
/
accounts
/
search
/
preview
Preview
curl --request POST \
  --url https://app.pipecorn.com/api/v2/accounts/search/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "included_industries": [
    "6",
    "96"
  ],
  "included_locations": [
    "103644278"
  ],
  "company_size": [
    "51-200",
    "201-500"
  ],
  "keyword": "saas"
}
'
import requests

url = "https://app.pipecorn.com/api/v2/accounts/search/preview"

payload = {
    "included_industries": ["6", "96"],
    "included_locations": ["103644278"],
    "company_size": ["51-200", "201-500"],
    "keyword": "saas"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    included_industries: ['6', '96'],
    included_locations: ['103644278'],
    company_size: ['51-200', '201-500'],
    keyword: 'saas'
  })
};

fetch('https://app.pipecorn.com/api/v2/accounts/search/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.pipecorn.com/api/v2/accounts/search/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'included_industries' => [
        '6',
        '96'
    ],
    'included_locations' => [
        '103644278'
    ],
    'company_size' => [
        '51-200',
        '201-500'
    ],
    'keyword' => 'saas'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.pipecorn.com/api/v2/accounts/search/preview"

	payload := strings.NewReader("{\n  \"included_industries\": [\n    \"6\",\n    \"96\"\n  ],\n  \"included_locations\": [\n    \"103644278\"\n  ],\n  \"company_size\": [\n    \"51-200\",\n    \"201-500\"\n  ],\n  \"keyword\": \"saas\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.pipecorn.com/api/v2/accounts/search/preview")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"included_industries\": [\n    \"6\",\n    \"96\"\n  ],\n  \"included_locations\": [\n    \"103644278\"\n  ],\n  \"company_size\": [\n    \"51-200\",\n    \"201-500\"\n  ],\n  \"keyword\": \"saas\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.pipecorn.com/api/v2/accounts/search/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"included_industries\": [\n    \"6\",\n    \"96\"\n  ],\n  \"included_locations\": [\n    \"103644278\"\n  ],\n  \"company_size\": [\n    \"51-200\",\n    \"201-500\"\n  ],\n  \"keyword\": \"saas\"\n}"

response = http.request(request)
puts response.read_body
{
  "total_count": 4321,
  "preview": [
    {
      "company_name": "Pipecorn",
      "industry": "Technology, Information and Internet",
      "linkedin_id": "104885158",
      "linkedin_url": "https://www.linkedin.com/company/104885158"
    }
  ]
}
{
  "error": 123,
  "message": "<string>"
}
{
  "error": 123,
  "message": "<string>"
}
{
  "error": 123,
  "message": "<string>"
}
Run the same filters as POST /accounts/search and get back a synchronous preview: the total estimated account count plus the first 25 matching companies. Use it to validate filters and size an audience before kicking off the real search.

Overview

Compared to POST /accounts/search, the preview:
  • Does not create an import job.
  • Does not call your webhook.
  • Does not consume credits.
  • Does not require webhook_url.
The body accepts the exact same filter parameters as the regular account search — see Search accounts by filters for the full reference (included_industries, excluded_industries, included_locations, excluded_locations, company_size, keyword, min_revenue, max_revenue, revenue_currency, …). webhook_url, name, limit, and streaming are accepted but ignored: the response always contains up to 25 accounts.

Rate Limits

  • 1 request per second per user/IP address.

Response

200 OK — returns immediately with:
{
  "total_count": 4321,
  "preview": [
    {
      "company_name": "Pipecorn",
      "industry": "Technology, Information and Internet",
      "linkedin_id": "104885158",
      "linkedin_url": "https://www.linkedin.com/company/104885158"
    }
  ]
}
FieldTypeNotes
total_countintegerTotal estimated number of accounts matching the filters (not capped to 25).
previewarray of objectsUp to 25 matching accounts. Each entry contains the fields listed above when available.

Example

{
  "included_industries": ["6", "96"],
  "included_locations": ["103644278"],
  "company_size": ["51-200", "201-500"],
  "keyword": "saas"
}

Authorizations

X-API-KEY
string
header
required

Your API key

Body

application/json

Accepts the same filter object as POST /accounts/search (included_industries, excluded_industries, included_locations, excluded_locations, company_size, keyword, min_revenue, max_revenue, revenue_currency, etc.), including live (default true) to preview from Pipecorn's companies database instead of LinkedIn Sales Navigator. webhook_url, name, limit, and streaming are accepted but ignored — the response is always the first 25 results.

Response

Preview generated successfully.

total_count
integer

Estimated total number of accounts matching the filters (not capped to 25).

preview
object[]

Up to 25 matching accounts.