Search for leads

This endpoint allows you to perform a precise search against our extensive up-to-date database of contacts and build leads lists.

We offer more than 20 filters that can be used to craft your perfect leads list.

This endpoint does not returns the email and mobile of the persons.

To enrich email and mobile from this endpoint, you can:

• submit a person_id you get from the search result to our Enrich Person endpoint.
• submit all of the person_id you get from the search result to our Bulk Enrich Person endpoint. Click here for more info about this process

In order to keep Prospeo’s infrastructure efficient, the maximum amount of results you can pull using this API is 25,000 (1000 pages of 25 results).

How are credits spent?

• 1 credit is spent per search request that returns at least one person.
• There are 25 results per page, hence 1 credit is spent for a maximum of 25 results.

Endpoint

• URL: https://api.prospeo.io/search-person 
• Method: POST
• Headers:
  • X-KEY: your_api_key
  • Content-Type: application/json

Parameters

How to perform a search?

There are two ways to build your search filters:

1. Dashboard UI helper - Use our dashboard to visually build your search and export the JSON payload (described below)
2. Filters Documentation - Refer to our complete Filters Documentation for all available filters and their values

Using the dashboard helper

curl --location 'https://api.prospeo.io/search-person' \
--header 'X-KEY: your_api_key' \
--header 'Content-Type: application/json' \
--data '{
    "page": 1,
    "filters": {
        "company_industry": {
            "exclude": [
                "Semiconductors",
                "Pet Services"
            ]
        },
        "person_seniority": {
            "include": [
                "Founder/Owner"
            ]
        },
        "person_year_of_experience": {
            "min": 10,
            "max": 50
        }
    }
}'

{
    "error": true,
	"error_code": "INVALID_FILTERS",
	"filter_error": "The value `Accountingg` is not supported for the filter `company_industry`."
}

{
    "error": false,
	"results": [
		{
			"person": ...
			"company": ...
		},
		{
			"person": ...
			"company": ...
		},
		{
			"person": ...
			"company": ...
		},
		... up to 25 per page
	],
	"pagination": {
		"current_page": 1,
		"per_page": 25,
		"total_page": 11,
		"total_count": 271
	} 
}

Paginate the results

You can use the page parameter to go paginate the complete result set. The maximum pages is always 1000 when using our API. Use the pagination in response to see how many pages exists.

Response details

Error codes

Filters

To understand how to use our filters, you have two options:

• Filters Documentation - Refer to our complete Filters Documentation for all available filters, their types, and accepted values.
• Dashboard UI - Use our dashboard UI as described here to visually build your search and see the generated payload.

Keep in mind that it is not allowed to perform a search solely with exclude filters for performance reasons.

Search from a list of company websites or names

There is no option in the UI builder to search using a list of company websites or names. This API still allows you to perform searches using those elements.

{
	"page": 1,
	"filters": {
		"company": {
			"websites": {
				"include": [
					"deloitte.com",
					"https://facebook.com/"
				]
			},
			"names": {
				"include": [
					"Walmart",
					"Microsoft"
				]
			}
		}
    }
}

ENUM filter values

Many filters are linked to an ENUM, which means that we accept a set list of values.

Below is the list of all the values allowed per filter:

• person_departments: Departments
• person_seniority: Seniorities
• company_industries: Industries
• company_headcount_range: Employee ranges
• company_funding: Funding stages
• company_technology: Technologies
• company_email_provider: MX providers
• company_naics: NAICS codes
• company_sics: SIC codes

Location filter values

As it can be seen on the dashboard, the company_location and the person_location both takes strings as values.

In order to ensure accuracy, the location strings you submit must match exactly the one you can pull from the dashboard.

We do not accept arbitrary location string such as “nyc”.

Alternatively, build a list of location by inserting them on the filter on the dashboard, look at the generated payload, and re-use those values.

Job title filter values

The person_job_title filter takes strings as values.

Alternatively, build a list of job titles by inserting them on the filter on the dashboard, look at the generated payload, and re-use those values.

Rate limit

See our rate limits page.