Authentication
To authenticate with the Prospeo API, add the header X-KEY
to your request.
You can find your API key on your dashboard (opens in a new tab).
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
curl -X POST \
-H "Content-Type: application/json" \
-H "X-KEY: your_api_key" \
-d '{
"first_name": "John",
"last_name": "Doe",
"company": "intercom.com"
}' \
"https://api.prospeo.io/email-finder"
Response
ℹ️
Read the error handling page to handle particular error codes.
- All the response will be in the
JSON
format. - Each response will always contain an error property:
false
if the request was successful,true
otherwise - Response codes:
200
: Valid request400
: An error occurred401
: Invalid API key429
: Rate limit exceeded- See error handling page for more info.
Example of a successful response (Email Finder API)
{
"error": false,
"response": {
"free": false,
"email": "[email protected]",
"email_anon_id": "24Z97EARRT",
"email_status": "VALID",
"first_name": "Ewa",
"last_name": "Kadlool",
"domain": "intercom.com",
"total_emails": 194
}
}
Example of an error response
{
"error": true,
"message": "INVALID_PARAM",
"details": "Invalid first_name param."
}