# Prospeo (/integrations/prospeo)





{/* MANUAL-CONTENT-START:intro */}

Use [Prospeo](https://prospeo.io/) 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.

{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]

Find verified work emails and mobile numbers, enrich person and company profiles, and search a B2B database of leads and companies using 20+ filters.

## Actions [#actions]

### Prospeo Account Information [#prospeo-account-information]

Retrieve the current plan, remaining credits, and renewal date of your Prospeo account.

<ReferenceDetails>
  #### Input [#input]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |

  #### Output [#output]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Enrich Person [#prospeo-enrich-person]

Enrich a person with complete B2B profile data, email address and mobile.

<ReferenceDetails>
  #### Input [#input-1]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `first_name` | string | No | First name of the person |
  | `last_name` | string | No | Last name of the person |
  | `full_name` | string | No | Full name of the person (alternative to first\_name + last\_name) |
  | `linkedin_url` | string | No | Person's public LinkedIn URL |
  | `email` | string | No | Work email of the person |
  | `company_name` | string | No | Company name |
  | `company_website` | string | No | Company website |
  | `company_linkedin_url` | string | No | Company's public LinkedIn URL |
  | `person_id` | string | No | Prospeo person\_id from a previous Search Person response |
  | `only_verified_email` | boolean | No | Only return records with a verified email |
  | `enrich_mobile` | boolean | No | Reveal mobile number (10 credits per match; email included) |
  | `only_verified_mobile` | boolean | No | Only return records that have a mobile (implies enrich\_mobile) |

  #### Output [#output-1]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Enrich Company [#prospeo-enrich-company]

Enrich a company with complete B2B data.

<ReferenceDetails>
  #### Input [#input-2]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `company_website` | string | No | Company website (e.g., "intercom.com") |
  | `company_linkedin_url` | string | No | Company's public LinkedIn URL |
  | `company_name` | string | No | Company name (use combined with website for best accuracy) |
  | `company_id` | string | No | Prospeo company\_id from a previously enriched company |

  #### Output [#output-2]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Bulk Enrich Person [#prospeo-bulk-enrich-person]

Enrich up to 50 person records at once.

<ReferenceDetails>
  #### Input [#input-3]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `data` | json | 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\_&#x2A;), or (full\_name + company\_*). |
  | `only_verified_email` | boolean | No | Only return records with a verified email |
  | `enrich_mobile` | boolean | No | Reveal mobile numbers (10 credits per match; email included) |
  | `only_verified_mobile` | boolean | No | Only return records that have a mobile (implies enrich\_mobile) |

  #### Output [#output-3]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Bulk Enrich Company [#prospeo-bulk-enrich-company]

Enrich up to 50 company records at once.

<ReferenceDetails>
  #### Input [#input-4]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `data` | json | 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. |

  #### Output [#output-4]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Search Person [#prospeo-search-person]

Search for leads using 20+ filters to build targeted contact lists.

<ReferenceDetails>
  #### Input [#input-5]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `filters` | json | Yes | Filter configuration object. See [https://prospeo.io/api-docs/filters-documentation](https://prospeo.io/api-docs/filters-documentation) for all supported filters (e.g., person\_seniority, company\_industry, person\_location). |
  | `page` | number | No | Page number (defaults to 1). Up to 1000 pages of 25 results. |

  #### Output [#output-5]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Search Company [#prospeo-search-company]

Search for companies using 20+ filters to build account lists.

<ReferenceDetails>
  #### Input [#input-6]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `filters` | json | Yes | Filter configuration object. See [https://prospeo.io/api-docs/filters-documentation](https://prospeo.io/api-docs/filters-documentation) for all supported filters (e.g., company\_industry, company\_headcount\_range, company\_funding). |
  | `page` | number | No | Page number (defaults to 1). Up to 1000 pages of 25 results. |

  #### Output [#output-6]

  | Parameter | 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 |
</ReferenceDetails>

### Prospeo Search Suggestions [#prospeo-search-suggestions]

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.

<ReferenceDetails>
  #### Input [#input-7]

  | Parameter | Type | Required | Description |
  | - | - | - | - |
  | `apiKey` | string | Yes | Prospeo API key |
  | `location_search` | string | No | Search query for location suggestions (minimum 2 characters). Mutually exclusive with job\_title\_search. |
  | `job_title_search` | string | No | Search query for job title suggestions (minimum 2 characters). Mutually exclusive with location\_search. |

  #### Output [#output-7]

  | Parameter | 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) |
</ReferenceDetails>