Introduction

Api endpoint

https://api.emailix.io/v1/ 

Welcome to the Emailix API! You can enjoy our service's features with our simple JSON API. Three main calls are available:

We have RESTful way to manage your Emailix's resources. These are the resources you can Create, Read, Update and Delete with our API:.

Structure

Successful Response:


  {
    "data": {
    ...
   },
    "meta": {
    ...
   }
  }  



Error Response:


                        
 {
     "errors": {
       ...
     }
   }
                         
 

Our API is designed to be as simple to use as possible. We always use the same basic structure:

1 - Data contains the data you requested:

2- Meta provides information regarding your request:

3- Errors shows errors with insights regarding what made the request fail. Learn more about the errors responses:

Authentication

Login To Get Your Api Key:

Authentication is made with a key you will have to add 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.

Api Key

Your API key is what identifies your account, so make sure to keep it secret! You can at anytime generate or delete API keys on your dashboard.

Remember — A happy Api is an authenticated Api!

Errors

400-Bad Request -- Your request is invalid.

201 - Created -- The request was successful and the resource was created.

202 - Email Verification in progress -- The Email Verification is still in progress. Feel free to make the same Verification again as often as you want, it will only count as a single request until we return the response..

204 - No content -- The request was successful and no additional content was sent.

222 - Email Verification failed -- The Email Verification failed because of an unexpected response from the remote SMTP server. This failure is outside of our control. We advise you to retry later.

400 - Bad request -- Your request was not valid.

401 - Unauthorized -- No valid API key was provided.

403 - Forbidden -- You have reached the rate limit.

404 - Not found -- The requested resource does not exist.

422 - Unprocessable entity -- Your request is valid but the creation of the resource failed. Check the errors. .

429 - Too many requests -- You have reached your usage limit. Upgrade your plan if necessary.

451 - Unavailable for legal reasons -- The person behind the requested resource has asked us directly or indirectly to stop the processing of this resource. For this reason, you shouldn't process this resource yourself in any way.

5XX - Server errors -- Something went wrong on Emailix's end. .

422 - Unprocessable entity -- Your request is valid but the creation of the resource failed. Check the errors. .

422 - Unprocessable entity -- Your request is valid but the creation of the resource failed. Check the errors. .

422 - Unprocessable entity -- Your request is valid but the creation of the resource failed. Check the errors. .

422 - Unprocessable entity -- Your request is valid but the creation of the resource failed. Check the errors. .

Emailix's API uses conventional HTTP response codes to indicate the success or failure of an API request. In case of an error, we'll return an array of errors containing information regarding what happened.

The Emailix API uses the following error codes:

Domain Search

Get Specific Domain

Response 200 OK

[
                      {
                        "domain": intercom.io,
                        "disposable": "false",
                        "webmail": "false",
                        "accept_all": false,
                        "emails": [...]
                      },

                     {
                      "meta": {...}
                      }

                  
                    
]

                    

One key feature of Emailix is to search all the email addresses corresponding to one website. You give one domain name and it returns all the email addresses using this domain name found on the internet.

HTTP Request

GET https://api.emailix.io/v1/domain-search?domain=intercom.io

Query Parameters

Parameter Description
Domain* Domain name from which you want to find the email addresses. For example, "stripe.com".
Company* The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
limit Specifies the max number of email addresses to return. The default is 10.
offset Specifies the number of email addresses to skip. The default is 0.
type Get only personal or generic email addresses.
api_key Your secret API key. You can generate it in your dashboard.

Email Finder

Get Specific Email

Response 200 OK

[
      {
        "domain": intercom.io,
        "disposable": "false",
        "webmail": "false",
        "accept_all": false,
        "emails": [...]
      },

     {
      "meta": {...}
      }

  
    
]

    

This API endpoint generates or retrieves the most likely email address from a domain name, a first name and a last name.

HTTP Request Example

GET GET https://api.emailix.io/v1/email-finder?domain=asana.com&first_name=Dustin&last_name=Moskovitz

HTTP Request Example with the company and full_name

GET https://api.emailix.io/v1/email-finder?company=Asana&full_name=Dustin+Moskovitz

Query Parameters

Parameter Description
Domain* Domain name from which you want to find the email addresses. For example, "stripe.com".
Company* The company name from which you want to find the email addresses. For example, "stripe". Note that you'll get better results by supplying the domain name as we won't have to find it. If you send a request with both the domain and the company name, we'll use the domain name. It doesn't need to be in lowercase.
first_name* The person's first name. It doesn't need to be in lowercase.
last_name* The person's last name. It doesn't need to be in lowercase.
full_name* The person's full name. Note that you'll get better results by supplying the person's first and last name if you can. It doesn't need to be in lowercase.
api_key* Your secret API key. You can generate it in your dashboard.
api_key Your secret API key. You can generate it in your dashboard.

The score returned is an estimation of the probability the email generated is correct.

If we have found the retrieved email address somewhere on the web, we display the sources here. The number of sources is limited to 20. The extracted_on attribute contains the date it was found for the first time, whereas the last_seen_on attribute contains the date it was found for the last time.

The Email Finder API call is rate limited to 300 requests per minute, with bursts of 10 requests per second.

* You must send at least the domain name or the company name. You can also send both. ** You must send at least the first name and the last name or the full name.

Email Verify

Get Specific Email verified

Response 200 OK

[
  {
    "domain": intercom.io,
    "disposable": "false",
    "webmail": "false",
    "accept_all": false,
    "emails": [...]
  },

 {
  "meta": {...}
  }



]

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

Emailix focuses on B2B. Therefore, webmails are not verified. We'll run every check but won't reach the remote SMTP server.

This endpoint is rate-limited by domain name. You can check up to 200 email addresses for a domain name every 24 hours. You can check the number of requests remaining using the X-RateLimit-Remaining header.

The request will run for 20 seconds. If it was not able to provide a response in time, we will return a 202 status code. You will then be able to poll the same endpoint to get the verification's result. Of course, all the requests in this case are counted only once.

HTTP Request Example

GET https://api.emailix.io/v2/email-verifier?email=steli@close.io

Query Parameters

Parameter Description
email* The email address you want to verify.
api_key* Your secret API key. You can generate it in your dashboard.