Clearout API Endpoints

`Instant Email Finder`

Instantly discover email address of any person giving their name and domain or company name

POST

                
  https://api.clearout.io/v2/email_finder/instant

                      
  curl -X POST 'https://api.clearout.io/v2/email_finder/instant' \
  -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Steven Morris", "domain": "apple.com", "timeout": 30000 }'

                      
  <?php
  $curl = curl_init();
  curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.clearout.io/v2/email_finder/instant',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{ "name": "Steven Morris", "domain": "apple.com", "timeout": 30000 }',
    CURLOPT_HTTPHEADER => array(
      "Content-Type: application/json",
      "Authorization: REPLACE_WITH_YOUR_API_TOKEN"
    ),
  ));
  
  $response = curl_exec($curl);
  $err = curl_error($curl);
  
  curl_close($curl);
  
  if ($err) {
    echo "cURL Error #:" . $err;
  } else {
    $response = json_decode($response, true);
    echo "Data: " . $response['data'] . "\n";
  }
  
  ?>

                      
  import java.io.*;
  import java.util.*;
  import org.apache.http.HttpResponse;
  import org.apache.http.NameValuePair;
  import org.apache.http.util.EntityUtils;
  import org.apache.http.client.HttpClient;
  import org.apache.http.entity.ContentType;
  import org.apache.http.entity.StringEntity;
  import org.apache.http.client.methods.HttpPost;
  import org.apache.http.message.BasicNameValuePair;
  import org.apache.http.impl.client.DefaultHttpClient;
  import org.apache.http.client.entity.UrlEncodedFormEntity;
  import org.json.JSONObject;
  
  public class InstantFinderExample {
   public static void main(String[] args) {
    try {
     HttpClient client = new DefaultHttpClient();
     HttpPost post = new HttpPost("https://api.clearout.io/v2/email_finder/instant");
  
     post.setHeader("Content-Type", "application/json");
     post.setHeader("Authorization","REPLACE_WITH_YOUR_API_TOKEN");
  
     String payload = '{ "name": "Steven Morris", "domain": "apple.com", "timeout": 30000 }';
     StringEntity requestEntity = new StringEntity( payload, ContentType.APPLICATION_JSON);
     post.setEntity(requestEntity);
     HttpResponse response = client.execute(post);
  
     JSONObject jsonResponse = new JSONObject(EntityUtils.toString(response.getEntity()));
     JSONObject result = jsonResponse.getJSONObject("data");
     System.out.println("Data: " + result.getString("data"));
    } catch(Exception e) {
     System.out.println(e);
    }
   }
  }

                      
  var request = require("request");
  var options = {
   method: 'POST',
   url: 'https://api.clearout.io/v2/email_finder/instant',
   headers: {
     'Content-Type': 'application/json',
     'Authorization': 'REPLACE_WITH_YOUR_API_TOKEN',
   },
   body: {
    name: 'Steven Morris',
    domain: 'apple.com',
    timeout: 30000
   },
   json: true
  };
  
  request(options, function (err, response, body) {
    if (err) throw new Error(err);
    if (body.status === 'success'){
      console.log('Name: ', body.data.full_name);
      console.log('Domain: ', body.data.domain);
      console.log('Data: ', body.data);
    } else {
      console.log(body)
    }
    
  });

                      
  import requests
  url = "https://api.clearout.io/v2/email_finder/instant"
  payload = '{ "name": "Steven Morris", "domain": "apple.com", "timeout": 30000 }'
  headers = {
      'Content-Type': "application/json",
      'Authorization': "REPLACE_WITH_YOUR_API_TOKEN",
      }
  response = requests.request("POST", url, data=payload, headers=headers)
  response = response.json()
  print('Data: ', response['data'], '\n')

                      
  package main

  import (
  "fmt"
  "io/ioutil"
  "net/http"
  "strings"
  "encoding/json"
  )
  
  type HttpResponseData struct {
   Data struct {
     Email string `json:"email_address"`
     Status string `json:"status"`
   } `json:"data"`
  }
  
  func main() {
  
    url := "https://api.clearout.io/v2/email_finder/instant"
    payload := strings.NewReader(`{ "name": "Steven Morris", "domain": "apple.com", "timeout": 30000 }`)
    req, _ := http.NewRequest("POST", url, payload)
  
    req.Header.Add("Content-Type", "application/json")
    req.Header.Add("Authorization", "REPLACE_WITH_YOUR_API_TOKEN")
  
    res, err := http.DefaultClient.Do(req)
    if err != nil {
        fmt.Println(err)
    } else {
      defer res.Body.Close()
      body, _ := ioutil.ReadAll(res.Body)
  
      var response HttpResponseData
      err = json.Unmarshal(body, &response)
      if err != nil {
        fmt.Println(err)
      }
      fmt.Println(string(body))
    }
  }

                      
                        using System;
                        using System.Text;
                        using System.Net.Http;
                        using System.Threading.Tasks;
                        using System.Net.Http.Headers;
                        
                        namespace Clearout.Examples
                        {
                            class InstantFinderExample
                            {
                                static HttpClient client = new HttpClient();
                                static async Task Main(string[] args)
                                {
                                    string jsonDataStr = "{ \"name\": \"Steven Morris\", \"domain\": \"apple.com\", \"timeout\": 30000 }";
                                    var postData = new StringContent(jsonDataStr, Encoding.UTF8, "application/json");
                        
                                    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", 
                                        ":" + "REPLACE_WITH_YOUR_API_TOKEN");

                                    var response = 
                                      await client.PostAsync("https://api.clearout.io/v2/email_finder/instant", postData);

                                    string result = response.Content.ReadAsStringAsync().Result;
                            
                                    Console.WriteLine(result);
                                }
                            }
                        }

                      
library('httr')
library('jsonlite')

res = POST(
"https://api.clearout.io/v2/email_finder/instant",
    add_headers(
        "Authorization" = "REPLACE_WITH_YOUR_API_TOKEN",
        "Content-Type" = "application/json"
        ),
    body = list(name = "Steven Morris", domain =  "apple.com", timeout = 30000 ),
    encode = "json"
)

content = rawToChar(res$content)
data = fromJSON(content)
jsonData = toJSON(data, pretty = TRUE)
print(jsonData)

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
name	String	Name of the person (eg: Mr. Tony Stark or Robert Downey Jr.)
domain	String	Domain or Company name (eg: marvel.com or Marvel Entertainment Company)
timeout optional	Number	Request wait time (in milliseconds), Maximum allowed wait time should not exceed 180,000 milliseconds Default value: `30,000 millsecs` Minimum value: `10,000 millsecs`
queue optional	Boolean	Flag to indicate whether email discovery can be performed in background even after the request timed out, this will help to retrieve result later using queue id or downloaded from Clearout App -> My Activities. Setting 'false' will stop the email discovery immediately when timeout occured Default Value: `true`

                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "emails": [
        {
          "email_address": "[email protected]",
          "role": "no",
          "business": "yes"
        }
      ],
      "first_name": "steven",
      "last_name": "morris",
      "full_name": "steven morris",
      "domain": "apple.com",
      "confidence_score": 83,
      "total": 1,
      "company": {
        "name": "apple"
      },
      "found_on": "2021-08-21T03:10:02.796Z"
    }
  }

                      
  HTTP/1.1 200 OK
  {
    "status": "failed",
    "error": {
      "code": 1088,
      "message": "Unsupported characters in name fields"
    }
  }

                      
  HTTP/1.1 400 Bad Request
  {
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [
            "name"
          ],
          "location": "body",
          "messages": [
            "\"name\" is not allowed to be empty"
          ],
          "types": [
            "any.empty"
          ]
        }
      ]
    }
  }

                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1099,
      "message": "You do not have sufficient credits for instant email finder"
    }
  }

                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }

                      
  HTTP/1.1 429 OK
  {
    "status": "failed",
    "error": {
      "message": "You have reached API rate limit, try calling after Fri Jul 27 2021 10:59:19 GMT+0530 (IST) or to increase limit, upgrade plan or reach [email protected]"
    }
  }

                      
  HTTP/1.1 503 Service Unavailable

                      
  HTTP/1.1 524 A Timeout Occurred
  {
    "status": "failed",
    "error": {
      "message": "Timeout occurred",
      "additional_info": {
        "resource_name": "email_finder",
        "resource_value": "{\"name\":\"Steven Morris\",\"domain\":\"apple.com\",\"timeout\":30000}",
        "queue_id": "61008c4597947d45700f4bb2"
      }
    }
  }

`Instant Email Finder Status`

To know the email finder request status in queue

GET

                
                  https://api.clearout.io/v2/email_finder/instant/queue_status

                      
  curl -X GET 'https://api.clearout.io/v2/email_finder/instant/queue_status?qid=REPLACE_WITH_YOUR_QUEUE_ID' \
  -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN' \
  -H 'Content-Type: application/json'

                      
  <?php
  $curl = curl_init();
  curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.clearout.io/v2/email_finder/instant/queue_status?qid=REPLACE_WITH_YOUR_QUEUE_ID',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
      "Content-Type: application/json",
      "Authorization: REPLACE_WITH_YOUR_API_TOKEN"
    ),
  ));
  
  $response = curl_exec($curl);
  $err = curl_error($curl);
  
  curl_close($curl);
  
  echo $response
  
  ?>

                      
  var request = require("request");
  var options = {
   method: 'GET',
   url: 'https://api.clearout.io/v2/email_finder/instant/queue_status?qid=REPLACE_WITH_YOUR_QUEUE_ID',
   headers: {
     'Content-Type': 'application/json',
     'Authorization': 'REPLACE_WITH_YOUR_API_TOKEN',
   },
   json: true
  };
  
  request(options, function (err, response, body) {
    if (err) throw new Error(err);
    console.log('Data: ', body.data);
  });

                      
  import requests
  url = "https://api.clearout.io/v2/email_finder/instant/queue_status?qid=REPLACE_WITH_YOUR_QUEUE_ID"
  payload = {}
  headers = {
      'Content-Type': "application/json",
      'Authorization': "REPLACE_WITH_YOUR_API_TOKEN",
      }
  response = requests.request("GET", url, data=payload, headers=headers)
  response = response.json()
  print('Data: ', response['data'], '\n')

                      
                        library('httr')
                        library('jsonlite')

                        res = GET(
                          "https://api.clearout.io/v2/email_finder/instant/queue_status?qid=REPLACE_WITH_YOUR_QUEUE_ID",
                          add_headers(
                              "Authorization" = "REPLACE_WITH_YOUR_API_TOKEN"
                              )
                          )
                      
                        content = rawToChar(res$content)
                        data = fromJSON(content)
                        jsonData = toJSON(data, pretty = TRUE)
                        print(jsonData)

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
qid	String	Queue ID received as part of the instant email finder response object

                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "query_status": "completed"
      "emails": [
        {
          "email_address": "[email protected]",
          "role": "no",
          "business": "yes"
        }
      ],
      "first_name": "steven",
      "last_name": "morris",
      "full_name": "steven morris",
      "domain": "apple.com",
      "confidence_score": 83,
      "total": 1,
      "company": {
        "name": "apple"
      },
      "found_on": "2021-08-21T03:10:02.796Z"
    }
  }

                      
  HTTP/1.1 200 OK
  {
    "status": "failed",
    "error": {
      "code": 1104,
      "message": "Invalid queue ID"
    }
  }

                      
  HTTP/1.1 400 Bad Request
  {
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [
            "qid"
          ],
          "location": "query",
          "messages": [
            "\"qid\" is required"
          ],
          "types": [
            "any.required"
          ]
        }
      ]
    }
  }

                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1099,
      "message": "You do not have sufficient credits for instant email finder"
    }
  }

                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }

                      
  HTTP/1.1 429 OK
  {
    "status": "failed",
    "error": {
      "message": "You have reached API rate limit, try calling after Fri Jul 27 2021 10:59:19 GMT+0530 (IST) or to increase limit, upgrade plan or reach [email protected]"
    }
  }

                      
  HTTP/1.1 503 Service Unavailable

                      
  HTTP/1.1 524 A Timeout Occurred
  {
    "status": "failed",
    "error": {
      "message": "Timeout occurred",
      "additional_info": {
        "resource_name": "email_finder",
        "resource_value": "",
        "queue_id": "61008c4597947d45700f4bb2"
      }
    }
  }

`Bulk Email Finder`

Use bulk finder API to discover the email address of the person in contact list of any size. Email discovery process will occur in background and once complete it will be notified through email. Use Bulk Email Finder Progress Status API to know the overall completion status of the list in percentage

POST

                
  https://api.clearout.io/v2/email_finder/bulk

                      
  curl -X POST 'https://api.clearout.io/v2/email_finder/bulk' \
  -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@/Users/clearout/Downloads/contacts.csv'

                      
   <?php
   $curl = curl_init();
   $file_name_with_full_path = "REPLACE_WITH_YOUR_FILE_PATH";
   if (function_exists('curl_file_create')) { // php 5.5+
     $cFile = curl_file_create($file_name_with_full_path);
   } else { //
     $cFile = '@' . realpath($file_name_with_full_path);
   }
  
   $post = array('file'=> $cFile);
   curl_setopt_array($curl, array(
     CURLOPT_URL => 'https://api.clearout.io/v2/email_finder/bulk',
     CURLOPT_MAXREDIRS => 10,
     CURLOPT_TIMEOUT => 30,
     CURLOPT_CUSTOMREQUEST => 'POST',
     CURLOPT_POSTFIELDS => $post,
     CURLOPT_HTTPHEADER => array(
       "Content-Type: multipart/form-data",
       "Authorization: REPLACE_WITH_YOUR_API_TOKEN"
     ),
   ));
  
   $response = curl_exec($curl);
   $err = curl_error($curl);
  
   curl_close($curl);
  
   if ($err) {
     echo "cURL Error #:" . $err;
   } else {
     echo $response;
   }
  ?>

                      
  import java.util.*;
  import java.io.*;
  import org.apache.http.HttpEntity;
  import org.apache.http.HttpResponse;
  import org.apache.http.util.EntityUtils;
  import org.apache.http.client.HttpClient;
  import org.apache.http.entity.ContentType;
  import org.apache.http.impl.client.HttpClients;
  import org.apache.http.client.methods.HttpPost;
  import org.apache.http.impl.client.CloseableHttpClient;
  import org.apache.http.entity.mime.MultipartEntityBuilder;
  import org.apache.http.client.methods.CloseableHttpResponse;
  
  public class BulkFinderExample {
   public static void main(String[] args) {
     try{
       CloseableHttpClient httpClient = HttpClients.createDefault();
       HttpPost uploadFile = new HttpPost("https://api.clearout.io/v2/email_finder/bulk");
       uploadFile.setHeader("Authorization"," REPLACE_WITH_YOUR_API_TOKEN");
       MultipartEntityBuilder builder = MultipartEntityBuilder.create();
  
       File f = new File("REPLACE_WITH_YOUR_FILE_PATH");
       builder.addBinaryBody(
         "file",
         new FileInputStream(f),
         ContentType.APPLICATION_OCTET_STREAM,
         f.getName()
       );
  
       HttpEntity multipart = builder.build();
       uploadFile.setEntity(multipart);
       CloseableHttpResponse response = httpClient.execute(uploadFile);
  
       System.out.println(EntityUtils.toString(response.getEntity()));
     } catch(Exception e) {
       System.out.println(e);
     }
   }
  }

                      
  var request = require("request");
  var fs = require("fs")
  var options = {
    method: "POST",
    url: "https://api.clearout.io/v2/email_finder/bulk",
    headers: {
      "Content-Type": "multipart/form-data",
      "Authorization": 'REPLACE_WITH_YOUR_API_TOKEN'
    },
    formData : {
      "file" : fs.createReadStream("REPLACE_WITH_YOUR_FILE_PATH")
    }
  };
  
  request(options, function (err, res, body) {
    if(err) throw new Error(err);
    console.log(body);
  });

                      
  import requests
  url = "https://api.clearout.io/v2/email_finder/bulk"
  filepath = "REPLACE_WITH_YOUR_FILE_PATH"
  files = {"file": open(filepath, "rb")}
  headers = {
    'Authorization': "REPLACE_WITH_YOUR_API_TOKEN",
  }
  response = requests.request( "POST", url, files=files, headers=headers)
  print(response.text)

                      
library('httr')
library('jsonlite')

res = POST(
  "https://api.clearout.io/v2/email_finder/bulk",
  add_headers(
      "Authorization" = "REPLACE_WITH_YOUR_API_TOKEN",
      "Content-Type" = "multipart/form-data"
    ),
    body = list(file = upload_file("REPLACE_WITH_YOUR_FILE_PATH")),
    encode = "multipart",
    verbose()
)

content = rawToChar(res$content)
data = fromJSON(content)
jsonData = toJSON(data, pretty = TRUE)
print(jsonData)

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
file	Object	Supported file extensions are .csv, .xlsx
ignore_duplicate_file optional	String	Whether to allow file with the same name and size that match with your recent upload. If not specified by default 'false'

                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "list_id": "610097bf5c6d3469958acd29"
    }
  }

                      
  HTTP/1.1 200 OK
  {
    "status": "failed",
    "error": {
      "code": 1083,
      "message": "You have reached the maximum number of email finder bulk requests, please try after the existing request completes or contact [email protected]"
    }
  }

                      
  HTTP/1.1 200 Ok
  {
    "status": "failed",
    "error": {
      "code": 1100,
      "message": "Invalid file type"
    }
  }

                      
  HTTP/1.1 200 OK
{
  "status": "failed",
  "error": {
    "code": 2043,
    "message": "Duplicate file not allowed, set ignore_duplicate_file=true to allow duplicate file",
    "additional_info": {
        "list_id": "610097bf5c6d3469958acd29"
    }
  }
}

                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1028,
      "message": "Your available credits 2799 is not enough to find 10000 email addresses from the list, so please purchase 37201 more credits",
      "additional_info": {
        "required_credits": 37201
      }
    }
  }

                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }

                      
  HTTP/1.1 503 Service Unavailable

`Bulk Email Finder Progress Status`

To know the overall progress status of the bulk finder request

GET

                
  https://api.clearout.io/v2/email_finder/bulk/progress_status

cURL

                      
  curl -X GET 'https://api.clearout.io/v2/email_finder/bulk/progress_status?list_id=61009cd65c6d3469958acdbf' \
  -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN'

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
list_id	String	List ID received as part of the email bulk finder response object

                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "progress_status": "completed",
      "percentage": 100
    }
  }

                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "progress_status": "running",
      "percentage": 89
    }
  }

                      
  HTTP/1.1 200 OK
  {
       "status": "failed",
       "error": {
         "code": 1008,
         "message": "You are not authorized to access this resource"
     }
  }

                      
  HTTP/1.1 400 Bad Request
  {
   "status": "failed",
   "error": {
     "message": "validation failed",
     "reasons": [
       {
         "field": [
           "list_id"
         ],
         "location": "query",
         "messages": [
           "\"list_id\" is not allowed to be empty"
         ],
         "types": [
           "any.empty"
         ]
       }
     ]
   }
  }

                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }

                      
  HTTP/1.1 200 OK
  {
    "status": "failed",
    "error": {
      "code": 1017,
      "message": "You have reached daily verify limit, please try next day or contact [email protected]"
    }
  }

                      
  HTTP/1.1 503 Service Unavailable

`Bulk Finder Result Download`

Bulk email finder result file download

POST

                
  https://api.clearout.io/v2/email_finder/download/result

cURL

                      
  curl -X POST 'https://api.clearout.io/v2/email_finder/download/result' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN' \
  -d '{"list_id": "61009e725c6d3469958ace0c"}'

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
list_id	String	List ID received as part of the email bulk finder response object

                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "url": "https://s3.ap-south-1.amazonaws.com/clearout.others/60f76977473718917ebc6edb/61009e745c6d3469958ace11/results/test3_appended_clearout_finder_results.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJXBOVX5Q2EULDUIA%2F20210728%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20210728T000244Z&X-Amz-Expires=300&X-Amz-Signature=e1e1c6340428d23d9aa37e57229f28025ae5f7510e27e102eb8eae901a0919c8&X-Amz-SignedHeaders=host"
    }
  }

                      
  HTTP/1.1 200 OK
  {
       "status": "failed",
       "error": {
         "code": 1029,
         "message": "List is not available"
       }
  }

                      
  HTTP/1.1 400 Bad Request
  {
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [
            "list_id"
          ],
          "location": "body",
          "messages": [
            "\"list_id\" is not allowed to be empty"
          ],
          "types": [
            "any.empty"
          ]
        }
      ]
    }
  }

                    
    HTTP/1.1 200 OK
    {
      "status": "failed",
      "error": {
        "code": 1007,
        "message": "Result file got expired, contact [email protected]"
      }
    }

                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1002
      "message": "You have exhausted your credits, please add additional credits to continue",
    }
  }

                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }

                      
  HTTP/1.1 503 Service Unavailable

`Bulk Email Finder Cancel`

Cancel running bulk finder contact list

POST

                
            https://api.clearout.io/v2/email_finder/list/cancel

cURL

                      
            curl -X POST 'https://api.clearout.io/v2/email_finder/list/cancel' \
            -H 'Content-Type: application/json' \
            -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN' \
            -d '{"list_id": "5d076c8e3b53f9b0f3cf6abb"}'

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
list_id	String	Pass the value of bulk finder list_id property from response object

                      
HTTP/1.1 200 OK
{
    "status": "success",
    "data": {
      name: "email_finder.xlsx",
      source: "upload",
      created_on: ""2022-05-16 10:41:30.427Z""
    }
}

                  
HTTP/1.1 200 OK
{
   "status": "failed",
   "error": {
     "code": 1116,
     "message": "List is not in the cancellable stage"
   }
}

                      
HTTP/1.1 200 OK
{
    "status": "failed",
    "error": {
      "code": 1029,
      "message": "List is not available"
    }
}

                      
HTTP/1.1 400 Bad Request
{
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [ "list_id" ],
          "location": "body",
          "messages": [ "\"list_id\" is required" ],
          "types": [ "any.required" ]
        }
      ]
    }
}

                    
HTTP/1.1 200 OK
{
    "status": "failed",
    "error": 
      {
        "code": 1007,
        "message": "Result file got expired, contact [email protected]"
      }
}

                      
HTTP/1.1 401 Unauthorized
{
    "status": "failed",
    "error": 
      {
        "code": 1000,
        "message": "Invalid API Token, please generate new token"
      }
}

                      
            HTTP/1.1 503 Service Unavailable

`Bulk Email Finder Removal`

Remove your bulk finder contact list

POST

                
  https://api.clearout.io/v2/email_finder/list/remove

cURL

                      
  curl -X POST 'https://api.clearout.io/v2/email_finder/list/remove' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: REPLACE_WITH_YOUR_API_TOKEN' \
  -d '{"list_id": "5d076c8e3b53f9b0f3cf6abb"}'

Header

Field	Type	Description
Content-Type	String	Default value: `application/json`
Authorization	String	Default value: `REPLACE_WITH_YOUR_API_TOKEN`

Parameter

Field	Type	Description
list_id	String	Pass the value of bulk finder list_id property from response object
ignore_result optional	Boolean	Set this value to true when file is not downloaded for first time, otherwise list removal will be denied. If not specified by default false

                      
  HTTP/1.1 200 OK
  {
       "status": "success",
       "data": {
          name: "email_finder.xlsx",
          source: "upload",
          created_on: "2022-05-16 10:41:30.427Z"
     }
  }

                      
  HTTP/1.1 200 OK
  {
       "status": "failed",
       "error": {
         "code": 1029,
         "message": "List is not available"
       }
  }

                      
  HTTP/1.1 400 Bad Request
  {
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [
            "list_id"
          ],
          "location": "body",
          "messages": [
            "\"list_id\" is required"
          ],
          "types": [
            "any.required"
          ]
        }
      ]
    }
  }

                    
    HTTP/1.1 200 OK
    {
      "status": "failed",
      "error": {
        "code": 1007,
        "message": "Result file got expired, contact [email protected]"
      }
    }

                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1002
      "message": "You have exhausted your credits, please add additional credits to continue",
    }
  }

                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }

                      
  HTTP/1.1 503 Service Unavailable

Email Finder API

Instant Email Finder

Header

Parameter

Instant Email Finder Status

Header

Parameter

Bulk Email Finder

Header

Parameter

Bulk Email Finder Progress Status

Header

Parameter

Bulk Finder Result Download

Header

Parameter

Bulk Email Finder Cancel

Header

Parameter

Bulk Email Finder Removal

Header

Parameter

`Instant Email Finder`

`Instant Email Finder Status`

`Bulk Email Finder`

`Bulk Email Finder Progress Status`

`Bulk Finder Result Download`

`Bulk Email Finder Cancel`

`Bulk Email Finder Removal`