Connection
- Authentication: API key (Prospeo API key).
In Prospeo (app.prospeo.io): left sidebar → “Enrich” → “API” (app.prospeo.io/api) → “Create API Key” → copy the key. Enrichments and searches spend credits (see prospeo.io for the plans); the credit balance and the filter lookups are free.See Prospeo’s documentation.
Read actions (6)
| Action | Description |
|---|---|
enrich_company | Lookup ONE company and return its profile (industry, size, location, revenue range, links, technologies…) (a read that spends credits). Spends 1 credit per matched company, 0 if no match or if enriched in the last 90 days. Arguments, at least ONE (all strings): company_website (root domain such as “intercom.com”, preferred), company_linkedin_url, company_id (from a previous result), company_name (ambiguous, avoid alone). |
enrich_person | Lookup ONE person and return the profile, company and work e-mail (a read that spends credits). Spends 1 credit per e-mail found and 10 credits when a mobile is requested and found (the e-mail is then included); 0 credit if no match or if the record was enriched in the last 90 days. A person that cannot be matched answers HTTP 400 error_code NO_MATCH (also when only_verified_email or only_verified_mobile is set and the record has none); INVALID_DATAPOINTS if the minimum is not met. Arguments, at least ONE of these combinations: first_name + last_name + one of (company_name, company_website, company_linkedin_url); full_name + one of (company_name, company_website, company_linkedin_url); linkedin_url; email; person_id (the id returned by search_person). All strings. Prefer company_website (root domain such as “intercom.com”) over company_name alone. Options: only_verified_email (boolean, default false: answer only if the e-mail is VERIFIED), enrich_mobile (boolean, default false: also reveal the mobile, costs 10 credits when found), only_verified_mobile (boolean, default false: answer only if a mobile exists, implies enrich_mobile). |
get_account_information | Get the account information: current plan, remaining and used credits, team members, next quota renewal date (a read, free). No argument. |
search_company | Search companies matching filters, 25 results per page, each with a company object (a read that spends credits). Spends 1 credit per request that returns at least one result (25 results per page), 0 if nothing matches or if the same page was already paid in the last 30 days. Arguments: filters (object, REQUIRED), page (integer 1 to 1000, default 1; read pagination.total_page in the answer). Filters (keys of the filters object; at least one positive filter is required, an exclude-only search is refused; send values exactly as the Prospeo docs and search_suggestions give them). Company filters: company { names | websites | company_oids: { include?: string[], exclude?: string[] } } (websites are root domains such as “stripe.com”, no www; company_oids is refused here: use names or websites), company_location_search { include?, exclude? } (values copied from search_suggestions with location_search), company_headcount_range (array of 1-10 | 11-20 | 21-50 | 51-100 | 101-200 | 201-500 | 501-1000 | 1001-2000 | 2001-5000 | 5001-10000 | 10000+), company_headcount_custom { min?: integer, max?: integer } (not with the range), company_industry { include?, exclude? } (exact industry names, e.g. “Software Development”), company_keywords { include: string[] (3 to 100 chars), exclude?, include_all?: boolean }, company_technology { include?, exclude? } (max 20, exact technology names), company_revenue { min?, max?, include_unknown_revenue?: boolean } (min/max among <100K | 100K | 500K | 1M | 5M | 10M | 25M | 50M | 100M | 250M | 500M | 1B | 5B | 10B+; paid plan), company_founded { min?: year, max?: year, include_unknown_founded?: boolean }, company_funding { stage?: string[], funding_date?: 30|60|90|180|270|365 (days), investors?: string[] } (paid plan), company_job_posting_hiring_for { include?, exclude?, match_type?: “contains” | “exact” } (paid plan). Any other filter of the Prospeo “Filters Documentation” page (NAICS/SIC codes, headcount growth, news, intent, website traffic, lookalike, ICP, attributes, key execs…) is accepted as is: pass its exact JSON form from that page; some need a paid plan (error PLAN_REQUIRED). Example: { “filters”: { “company_industry”: { “include”: [“Software Development”] }, “company_headcount_range”: [“51-100”, “101-200”], “company_location_search”: { “include”: [“France”] } } }. Errors: INVALID_FILTERS (see filter_error), PLAN_REQUIRED, NO_RESULTS. |
search_person | Search people matching filters, 25 results per page, each with a person and its current company; e-mails and mobiles are NOT returned (pass a person_id to enrich_person to reveal them) (a read that spends credits). Spends 1 credit per request that returns at least one result (25 results per page), 0 if nothing matches or if the same page was already paid in the last 30 days. Arguments: filters (object, REQUIRED), page (integer 1 to 1000, default 1; read pagination.total_page in the answer). Filters (keys of the filters object; at least one positive filter is required, an exclude-only search is refused; send values exactly as the Prospeo docs and search_suggestions give them). Company filters: company { names | websites | company_oids: { include?: string[], exclude?: string[] } } (websites are root domains such as “stripe.com”, no www; company_oids only on search_person), company_location_search { include?, exclude? } (values copied from search_suggestions with location_search), company_headcount_range (array of 1-10 | 11-20 | 21-50 | 51-100 | 101-200 | 201-500 | 501-1000 | 1001-2000 | 2001-5000 | 5001-10000 | 10000+), company_headcount_custom { min?: integer, max?: integer } (not with the range), company_industry { include?, exclude? } (exact industry names, e.g. “Software Development”), company_keywords { include: string[] (3 to 100 chars), exclude?, include_all?: boolean }, company_technology { include?, exclude? } (max 20, exact technology names), company_revenue { min?, max?, include_unknown_revenue?: boolean } (min/max among <100K | 100K | 500K | 1M | 5M | 10M | 25M | 50M | 100M | 250M | 500M | 1B | 5B | 10B+; paid plan), company_founded { min?: year, max?: year, include_unknown_founded?: boolean }, company_funding { stage?: string[], funding_date?: 30|60|90|180|270|365 (days), investors?: string[] } (paid plan), company_job_posting_hiring_for { include?, exclude?, match_type?: “contains” | “exact” } (paid plan). Any other filter of the Prospeo “Filters Documentation” page (NAICS/SIC codes, headcount growth, news, intent, website traffic, lookalike, ICP, attributes, key execs…) is accepted as is: pass its exact JSON form from that page; some need a paid plan (error PLAN_REQUIRED). Person filters: person_search { include?, exclude?: string[] (names, company names or domains), match_mode?: “SMART” | “STRICT” }, person_job_title { include?, exclude?: string[] (max 100), match_mode: “CONTAINS” | “EXACT” | “SIMILAR” } or { boolean_search: string, e.g. “(CEO OR CTO) AND !intern” } (not both), person_seniority { include? | exclude?: array of C-Suite | Director | Entry | Founder/Owner | Head | Intern | Manager | Partner | Senior | Vice President } (not both), person_department { include? | exclude?: string[] } (not both; e.g. “Sales”, “Marketing”, “Engineering & Technical”, “Finance”, “Operations”, “Product”, “Human Resources”, “C-Suite”), person_location_search { include?, exclude? } (values copied from search_suggestions with location_search), person_contact_details { email?: [“VERIFIED”], mobile?: [“VERIFIED” | “UNAVAILABLE”], operator?: “OR” | “AND”, hide_people_with_details_already_revealed?: boolean }, person_year_of_experience { min?: 0-60, max?: 1-60 }, person_time_in_current_role / person_time_in_current_company { min?, max? } (months), person_name_or_job_title (string), max_person_per_company (integer 1 to 100). Example: { “filters”: { “person_job_title”: { “include”: [“CTO”], “match_mode”: “CONTAINS” }, “company_headcount_range”: [“51-100”], “company_location_search”: { “include”: [“France”] }, “max_person_per_company”: 1 } }. Errors: INVALID_FILTERS (see filter_error), PLAN_REQUIRED, NO_RESULTS. |
search_suggestions | Lookup the exact values accepted by the search filters (a read, free; 15 calls per second). Pass EXACTLY ONE argument, a string of at least 2 characters, depending on the filter to fill: location_search (values for person_location_search and company_location_search, copy them unchanged), job_title_search, technology_search (company_technology), industry_search (company_industry), naics_search or sic_search (a code prefix or a label), or a company field: company_operating_languages_search, company_google_discovery_search, company_key_customers_search, company_integrations_search, company_products_services_products_search, company_products_services_services_search, company_icp_titles_search, company_icp_industries_search, company_icp_geographic_markets_search, company_icp_other_departments_search, company_awards_search, company_awards_compliance_search, company_headcount_by_location_search, company_funding_investors_search, company_funding_accelerator_search, company_website_traffic_countries_search. The answer carries the list under the matching *_suggestions key. |
Write actions (0)
This connector is read-only — it exposes no write actions.Permissions
Every action above must be explicitly granted to an agent before it can be used. See Permissions for the grant model and Security for how credentials are protected.Last reviewed against the provider API: October 2026.