Introduction

API Endpoint

https://api.coldlead.io/v1/

Welcome to ColdLead.io's API! You can use this API to access all our API endpoints.

The API is organized around REST. All requests should be made over SSL. All request and response bodies, including errors, are encoded in JSON.

Authentication

To authorize, use this code:

curl "https://api.coldlead.io/v1/api_endpoint_here" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {key}"

Authentication is done via the API key which you can find in your account settings.

You will have to add your API Key to every call you make to our API. This parameter is always required. We'll return an error if the key is either missing or invalid.

Your API key is what identifies your account, so be sure to keep it secret! Please don’t share it with anyone outside of your organization.

Authorization: Bearer myapikey

Errors

Our API uses conventional HTTP response codes to indicate the success or failure of an API request.

In case of an error, we will return the correspondent error code.

HTTP Status codes

Rate Limiting

Check to see how many requests we have left:

$ curl -i https://api.coldlead.io/v1/api_endpoint_here

HTTP/1.1 200 OK
Date: Thu, 08 Oct 2020 15:08:40 GMT
Status: 200 OK
X-RateLimit-Limit: 200
X-RateLimit-Remaining: 105

Example rate limit error response:

HTTP/1.1 429 Too Many Requests

X-RateLimit-Limit: 200
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1602169573
Retry-After: 50

Content-Type: application/json

{
  "message": "Too Many Attempts."
}

You can make 200 requests per minute to the API.

Check the returned HTTP headers of any API request to see your current rate limit status.

Account

Response:

{
  "data": {
    "id": "45b78561-11d8-4732-ac52-50daf46a3206",
    "email": "elon@tesla.com",
    "name": "Elon Musk",
    "company_name": "Tesla",
    "plan": "Pro",
    "credit_balance": 10000
  }
}

Information about your account on ColdLead.io

HTTP Request

GET|POST https://api.coldlead.io/v1/account

Parameters

This API doesn't require any parameters.

Email Verifier

Response:

{
  "data": {
    "email": "contact@coldlead.io",
    "username": "contact",
    "domain": "coldlead.io",
    "status": "deliverable",
    "reason": "accepted_email",
    "accept_all": false,
    "disposable": false,
    "role_address": true,
    "free": false
  }
}

This API endpoint allows you to verify the deliverability of an email address.

HTTP Request

GET|POST https://api.coldlead.io/v1/verify

Parameters

Response Detail

Email Finder

Response:

{
  "data": {
    "email": "satya@microsoft.com",
    "name": "Satya Nadella",
    "domain": "microsoft.com",
    "status": "deliverable",
    "accept_all": false
  }
}

The Email Finder API endpoint allows you to find emails programmatically. It returns an email based on a name and a domain name.

HTTP Request

GET|POST https://api.coldlead.io/v1/finder

Parameters

Response Detail