Skip to Content
Tools referenceProspecting and enrichment

Prospecting and enrichment

ToolWhat it does
find_mobileFind and reveal one person’s mobile number from a person ID, professional email, LinkedIn URL, or a name with company context (company name, website/domain, or company LinkedIn URL). Charges only when a mobile is available. An unmatched identity means only that the supplied details could not be matched, not that the person lacks a mobile, indexing, or verified data. A matched person without a mobile is reported separately. Do not speculate about causes or suggest invented email addresses; job title alone is not an accepted identifier.
search_leadsSearch people or companies using natural language, including lookalikes, saved people, saved companies, and lists. Not for reading a saved list (use list_get) or one company’s saved contacts (use record_company_people): those are free reads, a search costs a credit. Rerun a saved search by reference or refine it in natural language. Only the search service generates filters. Each result page costs at most 1 credit; empty pages and qualifying repeats are free. Continue a cursor with the same scope, entity and references without a query. Optionally keep only results at or above a score label (score_min), order by score (score_sort), or pick the score (score_id from score_list); server-run pages then carry score and score_label on each result. With a connected CRM, keep only records already in the CRM or hide them (crm_membership), or keep only members of CRM lists (crm_segment_ids from crm_segment_list).

find_mobile

Find and reveal one person’s mobile number from a person ID, professional email, LinkedIn URL, or a name with company context (company name, website/domain, or company LinkedIn URL). Charges only when a mobile is available. An unmatched identity means only that the supplied details could not be matched, not that the person lacks a mobile, indexing, or verified data. A matched person without a mobile is reported separately. Do not speculate about causes or suggest invented email addresses; job title alone is not an accepted identifier.

Find a mobile number for ONE person from name and company, email, LinkedIn URL, or person identifier, including people not yet saved to the caller’s team.

EndpointPOST https://api.prospeo.io/api/v2/tools/find-mobile
MCP toolfind_mobile on https://mcp.prospeo.io
EffectChanges data.
CreditsCan charge credits. At most 10 credits per item. The response’s charge field reports what was charged.
PermissionNo role permission beyond API access.
ConfirmationRecommended: MCP clients should confirm with the user before calling.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
dataobjectYesDatapoints identifying exactly one person.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

search_leads

Search people or companies using natural language, including lookalikes, saved people, saved companies, and lists. Not for reading a saved list (use list_get) or one company’s saved contacts (use record_company_people): those are free reads, a search costs a credit. Rerun a saved search by reference or refine it in natural language. Only the search service generates filters. Each result page costs at most 1 credit; empty pages and qualifying repeats are free. Continue a cursor with the same scope, entity and references without a query. Optionally keep only results at or above a score label (score_min), order by score (score_sort), or pick the score (score_id from score_list); server-run pages then carry score and score_label on each result. With a connected CRM, keep only records already in the CRM or hide them (crm_membership), or keep only members of CRM lists (crm_segment_ids from crm_segment_list).

Search people or companies from a natural-language audience description, including lookalikes, saved people, saved companies, lists, and owned saved-search reruns or refinements. Returns stable record IDs, interpreted criteria, pagination and the existing result-set billing outcome.

EndpointPOST https://api.prospeo.io/api/v2/tools/search-leads
MCP toolsearch_leads on https://mcp.prospeo.io
EffectChanges data.
CreditsCan charge credits. At most 1 credits per item. The response’s charge field reports what was charged.
PermissionNo role permission beyond API access.
ConfirmationRecommended: MCP clients should confirm with the user before calling.
PaginationCursor-based: cursor.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
querystringNoAudience in natural language, in the user’s own words; omit only to rerun a saved search or continue a cursor. Use exactly the job titles the user named: do not add related functions (a request for sales leaders must not mention marketing) and do not add generic words such as employee or team member. For the contacts of one company give the company and leave titles out. Whether people are already in the team’s CRM is not part of the query: set crm_membership instead. Length 3 to 1000.
entitystring (enum)NoOne of: person, company. Default "person".
scopestring (enum)NoWhere to search. list, saved_people and saved_companies only narrow records the team already saved by criteria; they are not for reading a list or an account’s contacts. To see who is in a list use list_get; for the saved contacts of one company use record_company_people. One of: database, saved_people, saved_companies, list. Default "database".
list_idstringNoPattern ^[a-fA-F0-9]{24}$.
saved_search_idstringNoPattern ^[a-fA-F0-9]{24}$.
cursorstringNoContinue the exact search with the same entity, scope and references; omit query. Pattern ^[a-f0-9]{64}$.
score_idstringNoScore results with this team score, an id returned by score_list. Omit to use the team’s primary score. Its target must match the entity. Pattern ^[a-fA-F0-9]{24}$.
score_minstring (enum)NoKeep only results scoring at least this label: excellent, good (good or better) or fair (fair or better). One of: excellent, good, fair.
score_sortstring (enum)NoOrder results by score: desc is highest first, asc is lowest first. Results without enough data come last. One of: desc, asc.
crm_membershipstring (enum)NoThe team’s connected CRM (HubSpot or Salesforce). hide leaves out records already in it (‘not in my HubSpot yet’, ‘leave out our CRM contacts’); only keeps just those already in it (‘only people already in Salesforce’). Needs a connected CRM whose setup is finished. One of: only, hide.
crm_segment_idsarray of stringNoKeep only members of these CRM lists or campaigns, ids returned by crm_segment_list. Needs a connected CRM. Up to 50 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Last updated on