Authentication

To authenticate with the Prospeo API, add the header X-KEY to your request.
You can find your API key on your dashboard . You have the ability to create multiple API keys.

Request

The host is api.prospeo.io
All requests should be made with HTTPS
All of our endpoints accept the POST method only

⚠️

You are required to add the header Content-Type: application/json

Below are minimal example of our Enrich Person API.

cURL


curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-KEY: your_api_key" \
  -d '{
        "only_verified_email": true,
        "enrich_mobile": false,
        "data": {
            "first_name": "John",
            "last_name": "Doe",
            "company_website": "intercom.com"
        }
    }' \
  "https://api.prospeo.io/enrich-person"

Python


import requests
 
url = "https://api.prospeo.io/enrich-person"
api_key = "your_api_key"
 
required_headers = {
    'Content-Type': 'application/json',
    'X-KEY': api_key
}
 
data = {
    'only_verified_email': True,
    'enrich_mobile': False,
    'data': {
        'first_name': 'John',
        'last_name': 'Doe',
        'company_website': 'intercom.com'
    }
}
 
response = requests.post(url, json=data, headers=required_headers)

PHP


$url = "https://api.prospeo.io/enrich-person";
$api_key = "your_api_key";
 
$headers = array(
    "Content-Type" => "application/json",
    "X-KEY" => $api_key
);
 
$data = array(
    "first_name" => "John",
    "last_name" => "Doe",
    "company" => "intercom.com"
);
 
$param = array(
    "only_verified_email" => true,
    "enrich_mobile" => false,
    "data" => $data
);
 
$options = array(
    CURLOPT_URL => $url,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_RETURNTRANSFER => true
);
 
$ch = curl_init();
curl_setopt_array($ch, $options);
$response = curl_exec($ch);
curl_close($ch);

JavaScript


const url = "https://api.prospeo.io/enrich-person";
const apiKey = "your_api_key";
 
const requiredHeaders = {
    "Content-Type": "application/json",
    "X-KEY": apiKey
};
 
const data = {
    only_verified_email: true,
    enrich_mobile: false,
    data: {
        first_name: 'John',
        last_name: 'Doe',
        company_website: 'intercom.com'
    }
}
 
fetch(url, {
    method: "POST",
    headers: requiredHeaders,
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(console.log);

Laravel w/ Guzzle


use GuzzleHttp\Client;
 
$url = "https://api.prospeo.io/enrich-person";
$api_key = "your_api_key";
 
$headers = [
    "Content-Type" => "application/json",
    "X-KEY" => $api_key
];
 
$data = [
    "only_verified_email" => true,
    "enrich_mobile" => false,
    "data" => [
        "first_name" => "John",
        "last_name" => "Doe",
        "company_website" => "intercom.com"
    ]
];
 
$client = new Client();
$response = $client->post($url, [
    "headers" => $headers,
    "json" => $data
]);
 
$body = $response->getBody();

Response

Read the error handling section of the endpoint page you need to handle errors.

All the response will be in JSON.
Each response will always contain an error property: false if the request was successful, true otherwise
Response codes:
- 200 : Valid request
- 400 : An error occurred
- 401 : Invalid API key
- 429 : Rate limit exceeded

Example of a successful response (Enrich Person API)

This response contains a revealed mobile (enrich_mobile:true).


{
	"error": false,
	"free_enrichment": false,
	"person": {
		"person_id": "681d3b5efb651de6f7ffdecb",
		"first_name": "Roger",
		"last_name": "Sterling",
		"full_name": "Roger Sterling",
		"linkedin_url": "https://www.linkedin.com/in/roger-sterling",
		"current_job_title": "Head of Ads",
		"current_job_key": "66d9e67b86199f0001b24246",
		"headline": "Head of Ads @ Prospeo.io | GTM pro",
		"linkedin_member_id": "161379400",
		"last_job_change_detected_at": "2024-08-27T21:18:29.577Z",
		"job_history": [
			{
				"title": "Head of Ads",
				"company_name": "Prospeo.io",
				"current": true,
				"start_year": 2024,
				"start_month": 12,
				"end_year": null,
				"end_month": null,
				"duration_in_months": 10,
				"departments": [
					"Online marketing",
					"Communication"
				],
				"seniority": "Head",
				"company_id": "63f53afe4ceeca00016bdd2f",
				"job_key": "66d9e67b86199f0001b24246"
			},
			{
				"title": "Managing Partner",
				"company_name": "Sterling-Cooper",
				"current": false,
				"start_year": 2014,
				"start_month": 7,
				"end_year": 2024,
				"end_month": 7,
				"duration_in_months": 120,
				"departments": [
					"Advertising"
				],
				"seniority": "Partner",
				"company_id": "50f53afe4ceeca00016bdd2f",
				"job_key": "60d9e67b16199f1001b24246"
			}
		],
		"mobile": {
			"status": "VERIFIED",
			"revealed": true,
			"mobile": "+1 234 567 8900",
			"mobile_national": "234 567 8900",
			"mobile_international": "+12345678900",
			"mobile_country": "United States",
			"mobile_country_code": "US"
		},
		"email": {
			"status": "VERIFIED",
			"revealed": true,
			"email": "roger@prospeo.io",
			"email_mx_provider": "Mimecast",
			"email_catch_all_domain": false
		},
		"location": {
			"country": "United States",
			"country_code": "US",
			"state": "California",
			"city": "Los Angeles",
			"time_zone": "America/Los_Angeles",
			"time_zone_offset": -8
		},
		"skills": [
			"Google Ads",
			"Paid media",
			"Marketing"
		]
	},
	"company": {
		"company_id": "63f53afe4ceeca00016bdd2f",
		"name": "Prospeo.io",
		"website": "https://prospeo.io",
		"domain": "prospeo.io",
		"other_websites": [],
		"description": "Say stop to bad quality data - find leads that respond.",
		"description_seo": "Prospeo is the most accurate email finder. Find emails from everywhere with our free tools.",
		"description_ai": "Prospeo is a searchable database of leads, offering quality data through verified emails and mobiles of B2B contacts.",
		"type": "Public",
		"industry": "Environmental Services",
		"employee_count": 4631,
		"employee_range": "1000-5000",
		"location": {
			"country": "Canada",
			"country_code": "CA",
			"state": "Ontario",
			"city": "Toronto",
			"raw_address": "Suite 1102, 20 Eglinton Ave W, M4R 1K8, Toronto, Canada"
		},
		"sic_codes": [
			"5045"
		],
		"naics_codes": [],
		"email_tech": {
			"domain": "prospeo.io",
			"mx_provider": "GOOGLE",
			"catch_all_domain": false
		},
		"linkedin_url": "http://www.linkedin.com/company/prospeoio",
		"twitter_url": "https://x.com/prospeoio/",
		"facebook_url": "https://www.facebook.com/prospeoio",
		"crunchbase_url": "https://www.crunchbase.com/organization/venture-capital",
		"instagram_url": "https://instagram.com/prospeoio/",
		"youtube_url": "https://youtuce.com/prospeoio/",
		"phone_hq": {
			"phone_hq": "+1 234 567 8900",
			"phone_hq_national": "234 567 8900",
			"phone_hq_international": "+12345678900",
			"phone_hq_country": "United States",
			"phone_hq_country_code": "US"
		},
		"linkedin_id": "18511550",
		"founded": 2015,
		"revenue_range": {
			"min": 5000000000,
			"max": 10000000000
		},
		"revenue_range_printed": "$ 5B-10B+",
		"keywords": [
			"Data quality",
			"B2B data",
			"Leads list"
		],
		"logo_url": "https://prospeoassets.s3.us-east-1.amazonaws.com/company_logo/GF45H5U785G18.jpg",
		"attributes": {
			"has_demo": false,
			"has_free_trial": true,
			"has_downloadable": false,
			"has_mobile_apps": null,
			"has_online_reviews": true,
			"has_pricing": true
		},
		"funding": {
			"count": 1,
			"total_funding": 1000000,
			"total_funding_printed": "$1M",
			"latest_funding_date": "2025-05-11",
			"latest_funding_stage": "Series A",
			"funding_events": [
				{
					"amount": 1000000,
					"amount_printed": "$1M",
					"raised_at": "2025-05-11",
					"stage": "Series A",
					"link": "https://www.crunchbase.com/funding_round/iq-business-south-africa-private-equity--6b34a99a"
				}
			]
		},
		"technology": {
			"count": 3,
			"technology_names": [
				"Google Analytics",
				"Mailchimp",
				"Outlook"
			],
			"technology_list": [
				{
					"name": "Google Analytics",
					"category": "Analytics"
				},
				{
					"name": "Mailchimp",
					"category": "Webmail"
				},
				{
					"name": "Outlook",
					"category": "Webmail"
				}
			]
		},
		"job_postings": {
			"active_count": 1,
			"active_titles": [
				"Rust engineer"
			]
		}
	}
}

Example of an error response


{
    "error": true,
    "error_code": "NO_MATCH"
}