Use Prospeo to search and enrich people and companies, including bulk enrichment. Search Suggestions supplies filter values such as locations and job titles; Account Information reports credit usage and plan status.
Find verified work emails and mobile numbers, enrich person and company profiles, and search a B2B database of leads and companies using 20+ filters.
Retrieve the current plan, remaining credits, and renewal date of your Prospeo account.
Parameter Type Required Description apiKeystring Yes Prospeo API key
Parameter Type Description current_planstring Current Prospeo plan name current_team_membersnumber Number of team members in your team remaining_creditsnumber Number of credits remaining used_creditsnumber Number of credits already used next_quota_renewal_daysnumber Days until the next quota renewal next_quota_renewal_datestring Date and time of the next quota renewal
Enrich a person with complete B2B profile data, email address and mobile.
Parameter Type Required Description apiKeystring Yes Prospeo API key first_namestring No First name of the person last_namestring No Last name of the person full_namestring No Full name of the person (alternative to first_name + last_name) linkedin_urlstring No Person's public LinkedIn URL emailstring No Work email of the person company_namestring No Company name company_websitestring No Company website company_linkedin_urlstring No Company's public LinkedIn URL person_idstring No Prospeo person_id from a previous Search Person response only_verified_emailboolean No Only return records with a verified email enrich_mobileboolean No Reveal mobile number (10 credits per match; email included) only_verified_mobileboolean No Only return records that have a mobile (implies enrich_mobile)
Parameter Type Description free_enrichmentboolean True if this enrichment was free (already enriched in the past) personjson The matched person object including person_id, name, linkedin_url, current_job_title, job_history, mobile, email, location, and skills companyjson The current company of the matched person including name, website, domain, industry, employee_count, location, social URLs, funding, and technology
Enrich a company with complete B2B data.
Parameter Type Required Description apiKeystring Yes Prospeo API key company_websitestring No Company website (e.g., "intercom.com") company_linkedin_urlstring No Company's public LinkedIn URL company_namestring No Company name (use combined with website for best accuracy) company_idstring No Prospeo company_id from a previously enriched company
Parameter Type Description free_enrichmentboolean True if this enrichment was free (already enriched in the past) companyjson The matched company object including name, website, domain, industry, employee_count, location, social URLs, funding, and technology
Enrich up to 50 person records at once.
Parameter Type Required Description apiKeystring Yes Prospeo API key datajson Yes Array of up to 50 person records to enrich. Each must include an "identifier" plus one of: linkedin_url, email, person_id, or (first_name + last_name + company_), or (full_name + company_ ). only_verified_emailboolean No Only return records with a verified email enrich_mobileboolean No Reveal mobile numbers (10 credits per match; email included) only_verified_mobileboolean No Only return records that have a mobile (implies enrich_mobile)
Parameter Type Description total_costnumber Total credits spent by the request matchedarray Matched records (identifier, person, company) ↳ identifier string The identifier you submitted for this record ↳ person json The matched person object ↳ company json The current company of the matched person not_matchedarray Identifiers of records we could not match given the filters invalid_datapointsarray Identifiers of records that did not meet the minimum matching requirements
Enrich up to 50 company records at once.
Parameter Type Required Description apiKeystring Yes Prospeo API key datajson Yes Array of up to 50 company records to enrich. Each must include an "identifier" plus one of: company_website, company_linkedin_url, company_name, or company_id.
Parameter Type Description total_costnumber Total credits spent by the request matchedarray Matched company records (identifier, company) ↳ identifier string The identifier you submitted for this record ↳ company json The matched company object not_matchedarray Identifiers of records we could not match invalid_datapointsarray Identifiers of records that did not meet the minimum matching requirements
Search for leads using 20+ filters to build targeted contact lists.
Parameter Type Required Description apiKeystring Yes Prospeo API key filtersjson Yes Filter configuration object. See https://prospeo.io/api-docs/filters-documentation for all supported filters (e.g., person_seniority, company_industry, person_location). pagenumber No Page number (defaults to 1). Up to 1000 pages of 25 results.
Parameter Type Description paginationobject Pagination details ↳ current_page number Current page number ↳ per_page number Results per page ↳ total_page number Total number of pages ↳ total_count number Total number of matching records freeboolean True if the request was free due to 30-day result-set deduplication resultsarray Up to 25 search results (person + company, no email/mobile) ↳ person json Matched person (no email/mobile in search response) ↳ company json Current company of the person
Search for companies using 20+ filters to build account lists.
Parameter Type Required Description apiKeystring Yes Prospeo API key filtersjson Yes Filter configuration object. See https://prospeo.io/api-docs/filters-documentation for all supported filters (e.g., company_industry, company_headcount_range, company_funding). pagenumber No Page number (defaults to 1). Up to 1000 pages of 25 results.
Parameter Type Description paginationobject Pagination details ↳ current_page number Current page number ↳ per_page number Results per page ↳ total_page number Total number of pages ↳ total_count number Total number of matching records freeboolean True if the request was free due to 30-day result-set deduplication resultsarray Up to 25 matching companies ↳ company json Matched company object
Free endpoint to retrieve valid location or job title values for use in Search filters. Provide exactly one of location_search or job_title_search.
Parameter Type Required Description apiKeystring Yes Prospeo API key location_searchstring No Search query for location suggestions (minimum 2 characters). Mutually exclusive with job_title_search. job_title_searchstring No Search query for job title suggestions (minimum 2 characters). Mutually exclusive with location_search.
Parameter Type Description location_suggestionsarray Location suggestions when using location_search (empty when searching job titles) ↳ name string Formatted location name to use in filters ↳ type string Location type (COUNTRY, STATE, CITY, or ZONE) job_title_suggestionsarray Up to 25 job title suggestions ordered by popularity when using job_title_search (empty when searching locations)