Bulk search

Icypeas provides you a route to launch your bulk search without going to the app!
When using the API, you have to provide:

• your user unique identifier (ID). See here to understand how to fetch it;
• the name of your bulk search so that you can find it later on;
• the task to execute on the data;
• the data you want to analyze;

Email-Search (task email-search):

The data array should contain rows with three elements:

1. The firstname
2. The lastname
3. The domain or company name

Firstname and/or lastname are optional. You need to put at least one of them, e.g.:
["John", "", "icypeas.com"]

Here is a request for an email-search:

{
  "task": "email-search",
  "user": "#YOUR-USER-ID",
  "name": "My cool email discovery",
  "data": [
    ["John", "Doe", "icypeas.com"],
    ["Charline", "Lestelle", "Google"],
    ["", "Avocado", "yelp.fr"],
    ["Jeanine", "", "Comodoro LLC"]
  ]
}

Email-Verification (task email-verification):

The data array should contain rows with one element: The email address.

Here is a request for an email-verification:

{
  "task": "email-verification",
  "user": "#YOUR-USER-ID",
  "name": "My cool email verification",
  "data": [
    ["john.doe@icypeas.com"],
    ["charline.lestelle@google.com"],
    ["jeanine@comodoro.com"],
  ]
}

Domain-Scan (task domain-search):

The data array should contain rows with one element: The domain or company name.

Here is a request for an domain-search:

{
  "task": "domain-search",
  "user": "#YOUR-USER-ID",
  "name": "My cool domain scan",
  "data": [
    ["icypeas.com"],
    ["google.com"],
    ["yelp.fr"],
    ["Comodoro LLC"],
  ]
}

caution

We put limits on the data that we can handle.
Each bulk search launched from the API can not contain more than 5000 items!

For your information: none of the parameters are optional.

POSThttps://app.icypeas.com/api/bulk-search

Start a new bulk search from the API.

BODY PARAMS

user*(has to be a userId)string

Your account's unique ID.

name*string

Name of the bulk search you are creating.

task*(has to be either 'domain-search', 'email-search' or 'email-verification')string

The type of bulk search you want to do.

data*array

Emails, prospects or domains you want to analyze.

row*array

Each row you want to be analyzed. If you are doing an 'email-search' you should have 3 items in each row.In other modes it's only 1 item.

/bulk-search

{
    "user": "#USERID#",
    "name": "Icypeas Prospects to analyze",
    "task": "email-search",
    "data": [
        [
            "John",
            "Doe",
            "icypeas.com"
        ],
        [
            "John",
            "Doe",
            "Icypeas"
        ]
    ]
}

RESPONSES