Enrich and search B2B contacts and companies
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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
| Paramètre | Type | Description |
|---|
current_plan | string | Current Prospeo plan name |
current_team_members | number | Number of team members in your team |
remaining_credits | number | Number of credits remaining |
used_credits | number | Number of credits already used |
next_quota_renewal_days | number | Days until the next quota renewal |
next_quota_renewal_date | string | Date and time of the next quota renewal |
Enrich a person with complete B2B profile data, email address and mobile.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
first_name | string | Non | First name of the person |
last_name | string | Non | Last name of the person |
full_name | string | Non | Full name of the person (alternative to first_name + last_name) |
linkedin_url | string | Non | Person's public LinkedIn URL |
email | string | Non | Work email of the person |
company_name | string | Non | Company name |
company_website | string | Non | Company website |
company_linkedin_url | string | Non | Company's public LinkedIn URL |
person_id | string | Non | Prospeo person_id from a previous Search Person response |
only_verified_email | boolean | Non | Only return records with a verified email |
enrich_mobile | boolean | Non | Reveal mobile number (10 credits per match; email included) |
only_verified_mobile | boolean | Non | Only return records that have a mobile (implies enrich_mobile) |
| Paramètre | Type | Description |
|---|
free_enrichment | boolean | True if this enrichment was free (already enriched in the past) |
person | json | The matched person object including person_id, name, linkedin_url, current_job_title, job_history, mobile, email, location, and skills |
company | json | 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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
company_website | string | Non | Company website (e.g., "intercom.com") |
company_linkedin_url | string | Non | Company's public LinkedIn URL |
company_name | string | Non | Company name (use combined with website for best accuracy) |
company_id | string | Non | Prospeo company_id from a previously enriched company |
| Paramètre | Type | Description |
|---|
free_enrichment | boolean | True if this enrichment was free (already enriched in the past) |
company | json | 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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
data | json | Oui | 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_email | boolean | Non | Only return records with a verified email |
enrich_mobile | boolean | Non | Reveal mobile numbers (10 credits per match; email included) |
only_verified_mobile | boolean | Non | Only return records that have a mobile (implies enrich_mobile) |
| Paramètre | Type | Description |
|---|
total_cost | number | Total credits spent by the request |
matched | array | 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_matched | array | Identifiers of records we could not match given the filters |
invalid_datapoints | array | Identifiers of records that did not meet the minimum matching requirements |
Enrich up to 50 company records at once.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
data | json | Oui | 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. |
| Paramètre | Type | Description |
|---|
total_cost | number | Total credits spent by the request |
matched | array | Matched company records (identifier, company) |
↳ identifier | string | The identifier you submitted for this record |
↳ company | json | The matched company object |
not_matched | array | Identifiers of records we could not match |
invalid_datapoints | array | Identifiers of records that did not meet the minimum matching requirements |
Search for leads using 20+ filters to build targeted contact lists.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
filters | json | Oui | Filter configuration object. See https://prospeo.io/api-docs/filters-documentation for all supported filters (e.g., person_seniority, company_industry, person_location). |
page | number | Non | Page number (defaults to 1). Up to 1000 pages of 25 results. |
| Paramètre | Type | Description |
|---|
pagination | object | 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 |
free | boolean | True if the request was free due to 30-day result-set deduplication |
results | array | 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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
filters | json | Oui | Filter configuration object. See https://prospeo.io/api-docs/filters-documentation for all supported filters (e.g., company_industry, company_headcount_range, company_funding). |
page | number | Non | Page number (defaults to 1). Up to 1000 pages of 25 results. |
| Paramètre | Type | Description |
|---|
pagination | object | 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 |
free | boolean | True if the request was free due to 30-day result-set deduplication |
results | array | 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.
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Prospeo API key |
location_search | string | Non | Search query for location suggestions (minimum 2 characters). Mutually exclusive with job_title_search. |
job_title_search | string | Non | Search query for job title suggestions (minimum 2 characters). Mutually exclusive with location_search. |
| Paramètre | Type | Description |
|---|
location_suggestions | array | 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_suggestions | array | Up to 25 job title suggestions ordered by popularity when using job_title_search (empty when searching locations) |
