Retrieve your results

We store each of your results into what we call a search item. When you do a single search, there is one search item linked to your single search. When you do a bulk search, you have as many search items as the number of rows in your data.

Search items are precise description of a result. It contains:

• The found email(s).
• The status of the search.
• The firstname / lastname of the person (if found).
• The level of verification.
• ...

Extract a single result using the id:

Everytime you do a single search, a _id is returned to you. If you need to retrieve the whole result for this search, you can use this route with the returned _id.

This also works with bulk search' results, if you want to fetch a particular result.

Imagine, you've run a single search, with the following response:

{
    "success": true,
    "item": {
        "_id": "kMnquYkBTs8kZM9ND26h",
        "status": "NONE",
    }
}

Then you need to retrieve the result from this single search, you simply call this route with:

{
    "user": "#USERID#",
    "mode": "single",
    "id": "kMnquYkBTs8kZM9ND26h"
}

You'll get the result for this specific _id.

tip

If you don't know how to fetch your user id, please see here.

Here is the list of the complete parameters and responses:

POSThttps://app.icypeas.com/api/bulk-single-searchs/read

Get your results from single searches

BODY PARAMS

user*(has to be a userId)string

Your account's unique ID.

mode*(single or bulk)string

single mode means retrieving single searches / bulk mode means retrieving bulk searches

id*(existing id)string

the result' _id you want to retrieve

/api/bulk-single-searchs/read

{
    "user": "#USERID#",
    "mode": "single",
    "id": "kMnquYkBTs8kZM9ND26h"
}

RESPONSES

Extract results from single searches:

Below you'll find the way to retrieve all your results linked to single searches. They are sorted by date of creation, so the latest one is at the top of the results. You can limit the number of retrieved results with a maximum at 50.

tip

If you don't know how to fetch your user id, please see here.

The route is paginated, if you don't know how to handle pagination, please read here.

POSThttps://app.icypeas.com/api/bulk-single-searchs/read

Get your results from single searches

BODY PARAMS

user*(has to be a userId)string

Your account's unique ID.

mode*(single)string

single mode means retrieving single searches

limit*number

Limit of files to send (max is 50).

type(domain-search, email-search or email-verification)string

The type of search you want to fetch. Leave empty, if you want to retrieve any kind of searches

nextboolean

If you want to paginate, use this field. true = next page | false = previous page

sortsarray

Array used to paginate your files, it is this item you need to pass to your requests to fetch the next page

sort item*number

Tuples of (number, string)

/api/bulk-single-searchs/read

{
    "user": "#USERID#",
    "mode": "single",
    "limit": 50,
    "type": "domain-scan"
}

RESPONSES

Extract results from bulk searches:

Below you'll find the way to retrieve all your results linked to bulk searches. They are sorted by date of creation, so the latest one is at the top of the results. You can limit the number of retrieved results with a maximum at 50.

tip

If you don't know how to fetch your user id, please see here.

The route is paginated, if you don't know how to handle pagination, please read here.

POSThttps://app.icypeas.com/api/bulk-single-searchs/read

Get results from bulk searches

BODY PARAMS

user*(has to be a userId)string

Your account's unique ID.

file(has to be a valid fileId)string

The file id for your bulk. Useful when you want to retrieve only the searches for a given bulk

mode*(bulk)string

Type of results (bulk for bulk search)

limit*number

Limit of files to send.

file*(This is a file id)string

The unique ID of the file you want to fetch.

nextboolean

If you want to paginate, use this field. true = next page | false = previous page

sortsarray

Array used to paginate your files, it is this item you need to pass to your requests to fetch the next page

sort item*number

Tuples of (number, string)

/api/bulk-single-searchs/read

{
    "user": "#USERID#",
    "mode": "bulk",
    "limit": 50,
    "file": "#FILEID#"
}

RESPONSES