API Documentation

MineLead API (1.0)

Download OpenAPI specification:Download

MineLead API helps you find company emails, generate leads, and create value for youself and for other.

Authentication

api_key

Security scheme type: API Key
Query parameter name: key

Search

Search for leads

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
domain
required
string
Example: "domain.com"
name
string
Example: "company name"

If no domain is provided and name is given, search will be based on name

max-emails
number
Example: "max-emails=4"

Display a maximum of 4 emails for a domain (optional)

generic
boolean
Example: "generic=true"

Display only generic emails (optional)

light-mode
boolean
Example: "light_mode=true"

Display only already found emails

Responses

200
get /search
https://api.minelead.io/v1/search

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/search/?domain=www.example.com&key=yourapikey&max-emails=4"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "domain": "domain.com",
  • "status": "found",
  • "pattern": "{pattern}@domain.com",
  • "emails":
    [
    ]
}

Validate

Check the validity of an email address

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
email
required
string
Example: "email@domain.com"
firstname
string
Example: "john"
lastname
string
Example: "doe"

Responses

200
get /validate
https://api.minelead.io/v1/validate

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/validate/?email=name@example.com&key=yourapikey&firstname=john&lastname=doe"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success || catch-all",
  • "form": true,
  • "webmail": true,
  • "mx": true,
  • "exist": true,
  • "firstname": "john",
  • "lastname": "doe"
}

Find

Find a professional email using a firstname and a lastname

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
domain
required
string
Example: "example.com"
firstname
required
string
Example: "firstname"
lastname
required
string
Example: "lastname"

Responses

200
get /find
https://api.minelead.io/v1/find

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/find/?domain=example.com&firstname=john&lastname=smith&key=yourapikey"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "domain": "example.com",
  • "firstname": "john",
  • "lastname": "smith",
  • "email": "jsmith@example.com"
}

Generate

Generate leads from tags

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
Request Body schema: application/json
tags
Array of strings

Responses

200
post /tags
https://api.minelead.io/v1/tags

Request samples

application/json
Copy
Expand all Collapse all
{
  • "tags":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "companies":
    [
    ]
}

List leads

List your leads

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"

Responses

200
get /leads
https://api.minelead.io/v1/leads

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/leads/?key=yourapikey"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "leads":
    [
    ]
}

Add Lead

Add a lead to your leads

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
Request Body schema: application/json
email
Array of strings

Responses

200
post /leads
https://api.minelead.io/v1/leads

Request samples

application/json
Copy
Expand all Collapse all
{
  • "leads":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "message":
    [
    ]
}

Edit Lead

Edit a lead from your leads

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
Request Body schema: application/json
email
Array of strings

Responses

200
put /leads
https://api.minelead.io/v1/leads

Request samples

application/json
Copy
Expand all Collapse all
{
  • "email":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "message":
    [
    ]
}

Delete Lead

Delete a lead from your leads

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
Request Body schema: application/json
email
Array of strings

Responses

200
delete /leads
https://api.minelead.io/v1/leads

Request samples

application/json
Copy
Expand all Collapse all
{
  • "email":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "message":
    [
    ]
}

History - List

List your search history

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
start
required
integer <int32>
Example: 0
limit
required
integer <int32>
Example: 7

Responses

200
get /history
https://api.minelead.io/v1/history

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/history/?start=0&limit=10&key=yourapikey"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "history":
    [
    ]
}

Campaigns - List

List your campaigns

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"

Responses

200
get /campaigns
https://api.minelead.io/v1/campaigns

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/campaigns/?key=yourapikey"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "campaigns":
    [
    ]
}

Recipients - List

List your campaigns recipients lists

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"

Responses

200
get /campaigns-recipients
https://api.minelead.io/v1/campaigns-recipients

Request samples

Copy
curl -L -X GET "https://api.minelead.io/v1/campaigns/?key=yourapikey"

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "recipient_list":
    [
    ]
}

Create Recipients List

Create a recipient list

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
Request Body schema: application/json
list_name
string
emails
Array of strings

Responses

200
post /campaigns-recipients
https://api.minelead.io/v1/campaigns-recipients

Request samples

application/json
Copy
Expand all Collapse all
{
  • "list_name": "mylist",
  • "emails":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "id": 1,
  • "name": "mylist"
}

Edit Recipients List

Add or remove emails from a recipients list

Authorizations:
api_key (trial)
query Parameters
key
required
string
Example: "myApiKey"
Request Body schema: application/json
id
number
operation
string
emails
Array of strings

Responses

200
put /campaigns-recipients
https://api.minelead.io/v1/campaigns-recipients

Request samples

application/json
Copy
Expand all Collapse all
{
  • "id": 1,
  • "operation": "add/remove",
  • "emails":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "message": "list edited successfully"
}

Account

Get account informations

Authorizations:
api_key (trial)
Request Body schema: application/json
key
string

Your api key

Responses

200
post /account
https://api.minelead.io/v1/account

Request samples

application/json
Copy
Expand all Collapse all
{
  • "key": "myApiKey"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "success",
  • "message": "Authenticated",
  • "data":
    {
    }
}
Recherche ...
×
Définir un Mot de passe
Vous avez créé votre compte à l'aide de Google SSO. Vous devez définir un mot de passe.

Vérification du numéro de téléphone