CRM integrations
| Tool | What it does |
|---|---|
crm_connection_get | Whether HubSpot or Salesforce is connected to the team, its setup and sync state, and the Free-plan record cap. |
crm_dedup_report | Read duplicate groups by object type and confidence with pagination. |
crm_dedup_status | Read CRM duplicate scan progress. |
crm_enrichment_report | Read paginated CRM enrichment field outcomes and credit totals, withholding raw contact values. |
crm_enrichment_status | Read CRM enrichment job progress and pending status. |
crm_find_contact_data | Find work emails and/or mobiles for selected CRM people (at most 2,000 per run) and write them into the CRM. Paid, only for values found: a Prospeo email is 1 credit and a mobile 10; values found through the team’s enrichment providers cost up to 7 per email and 50 per mobile. In the app the user approves the estimate first. |
crm_health_report | Read the saved report of one finished CRM data-quality scan by its scan id. For a general CRM data-quality question use crm_health_summary. |
crm_health_status | Read CRM health scan progress. |
crm_health_summary | The connected CRM’s Health, no scan or id needed: records missing data, data fillable from Prospeo, drift, duplicate groups, pending job changes, credits spent. |
crm_job_change_apply | Write the new job title and company from pending CRM job changes into the CRM records; in Salesforce a contact may be moved to the new company’s account, created if needed. 1 credit per record written, refunded if the CRM does not accept it. In the app the user approves the cost first. |
crm_job_changes_list | Pending job changes for selected CRM people (old and new title and company), with the ids needed to apply them to the CRM. |
crm_job_get | Progress and outcome of a CRM Find contact data or Sync job by id, or the recent Find contact data jobs when no id is given. |
crm_record_get | One CRM record with its CRM values beside Prospeo’s, field by field, and for a company the people linked to it; Prospeo emails and mobiles the team has not revealed stay hidden. |
crm_record_search | Search the connected CRM’s contacts, leads, companies or accounts by words or CRM list, 10 per page, with whether each is in Prospeo, has data available or a pending job change. |
crm_segment_list | The connected CRM’s lists (HubSpot) or campaigns and list views (Salesforce), with sizes and ids for searching. |
crm_sync_records | Send Prospeo saved contacts, or a whole list, to the connected CRM: create missing records and fill blank fields; overwrite only the fields the user asked to. Free. In the app the user approves the preview first. |
integration_errors | List sanitized errors for one accessible integration. |
integrations_status | Get connection state and sanitized events for one integration. |
push_history | List accessible integration push history with pagination. |
crm_connection_get
Whether HubSpot or Salesforce is connected to the team, its setup and sync state, and the Free-plan record cap.
Say whether HubSpot or Salesforce is connected to the team, whether its setup is finished, whether its data is current or needs a reconnect, when it last synced, and on the Free plan how many records the mirror holds against its 50,000-record cap. Use first for any question about the connected CRM, and to tell the user where to connect one when none is connected.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-connection-get |
| MCP tool | crm_connection_get on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns 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.
This endpoint takes an empty body: {}.
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_dedup_report
Read duplicate groups by object type and confidence with pagination.
Fetch the paginated report of duplicate-record groups found by a completed CRM deduplication scan (HubSpot/Salesforce), with per-group confidence score, match reasons, and the candidate CRM records. Call after crm_dedup_status shows status=COMPLETED to answer ‘how many duplicates were found’ before the user opens the guarded merge UI (merge itself is not a tool).
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-dedup-report |
| MCP tool | crm_dedup_report on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View team CRM enrichment history (crm_enrichment.history.team.view) |
| Confirmation | Not needed. |
| Pagination | Page-based: page, per_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.
| Parameter | Type | Required | Description |
|---|---|---|---|
background_process_oid | string | Yes | Length 24 to 24. Pattern ^[a-f0-9]{24}$. |
page | integer | No | From 1 to any. Default 1. |
per_page | integer | No | From 1 to 100. Default 20. |
object_type | string | No | Filter by object type: contact, lead, company |
min_confidence | number | No | Minimum confidence threshold From 0 to 1. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_dedup_status
Read CRM duplicate scan progress.
Poll a CRM deduplication scan’s progress by its background_process_oid — status, percent complete, and running totals of records scanned and duplicate groups found so far. Use right after starting a dedup scan, or whenever the user asks if it’s done, before calling crm_dedup_report.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-dedup-status |
| MCP tool | crm_dedup_status on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | Start CRM enrichment (crm_enrichment.start) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
background_process_oid | string | Yes | Length 24 to 24. Pattern ^[a-f0-9]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_enrichment_report
Read paginated CRM enrichment field outcomes and credit totals, withholding raw contact values.
Fetch the field-by-field diff report for a completed CRM enrichment job — every CRM field Prospeo changed with old vs. new value and per-field success/failure, paginated (capped at 10,000 changes). Use to answer ‘what did the HubSpot/Salesforce enrichment actually update’ once crm_enrichment_status shows the job finished.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-enrichment-report |
| MCP tool | crm_enrichment_report on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View team CRM enrichment history (crm_enrichment.history.team.view) |
| Confirmation | Not needed. |
| Pagination | Page-based: page, page_size. |
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.
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | string | Yes | Length 24 to 24. Pattern ^[a-f0-9]{24}$. |
page | integer | No | From 1 to any. Default 1. |
page_size | integer | No | From 1 to 500. Default 50. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_enrichment_status
Read CRM enrichment job progress and pending status.
Poll a CRM enrichment job’s progress — status, records processed vs. total, percent complete, and (if paused for capacity) why it’s pending and the estimated retry wait. Use right after starting/resuming a CRM enrichment, or whenever the user asks how it’s going.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-enrichment-status |
| MCP tool | crm_enrichment_status on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | Start CRM enrichment (crm_enrichment.start) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | string | Yes | Length 24 to 24. Pattern ^[a-f0-9]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_find_contact_data
Find work emails and/or mobiles for selected CRM people (at most 2,000 per run) and write them into the CRM. Paid, only for values found: a Prospeo email is 1 credit and a mobile 10; values found through the team’s enrichment providers cost up to 7 per email and 50 per mobile. In the app the user approves the estimate first.
Find work emails and/or mobiles for selected people in the connected CRM and write what is found into the CRM, after the user approves the estimate. Selection is listed CRM record ids or every record matching a CRM search or list, at most 2,000 records per run. Optionally also saves them to a Prospeo list for free. More than one record runs as a background job.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-find-contact-data |
| MCP tool | crm_find_contact_data on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Can charge credits. At most 57 credits per item. The response’s charge field reports what was charged. |
| Permission | Edit & push CRM records (crm.edit_and_push) |
| Confirmation | Recommended: MCP clients should confirm with the user before calling. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
object_type | string (enum) | Yes | CONTACT, or LEAD for Salesforce leads. Contact data is found for people only. One of: CONTACT, LEAD. |
record_ids | array of string | No | CRM record ids from a CRM record search. Up to 1000 items. |
all_matching | boolean | No | Select every record matching segment_ids and search instead of listing ids. Default false. |
segment_ids | array of string | No | With all_matching: only records in these CRM lists or campaigns. Up to 50 items. |
search | string | No | With all_matching: only records whose own text matches these words. People are not matched on their linked company, so for the people at a company pass their record_ids (from crm_record_search linked_people or crm_record_get) instead. Length 0 to 200. |
exclude_record_ids | array of string | No | With all_matching: records to leave out. Up to 1000 items. |
include_leads | boolean | No | Salesforce only: with CONTACT, also include Leads. Default false. |
datapoints | array of string (enum) | Yes | Which contact data to find and write into the CRM. Up to 2 items. Items one of: email, mobile. |
save_to_list_id | string | No | Optional Prospeo list id to also save these people to, free. Pattern ^[0-9a-fA-F]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_health_report
Read the saved report of one finished CRM data-quality scan by its scan id. For a general CRM data-quality question use crm_health_summary.
Fetch the full CRM health report for a completed scan: per-object-type (contact/lead/company) stats on record freshness plus email/mobile/job-title accuracy vs. Prospeo’s own data. Needs the scan’s background_process_oid, so use it only for a specific finished scan, once crm_health_status shows it COMPLETED. For a general ‘how good is my CRM data’ question use crm_health_summary, which needs no scan.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-health-report |
| MCP tool | crm_health_report on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View team CRM enrichment history (crm_enrichment.history.team.view) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
background_process_oid | string | Yes | Length 24 to 24. Pattern ^[a-f0-9]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_health_status
Read CRM health scan progress.
Poll the status and progress of a CRM health scan by its background_process_oid. Use right after starting a health scan, or when the user asks if it’s done, before calling crm_health_report.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-health-status |
| MCP tool | crm_health_status on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | Start CRM enrichment (crm_enrichment.start) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
background_process_oid | string | Yes | Length 24 to 24. Pattern ^[a-f0-9]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_health_summary
The connected CRM’s Health, no scan or id needed: records missing data, data fillable from Prospeo, drift, duplicate groups, pending job changes, credits spent.
Show the connected CRM’s Health per object type: how many records, how many miss a key field and how many of those Prospeo could fill, how many differ from Prospeo or are not in Prospeo, duplicate groups, pending job changes, credits spent by CRM actions and the last failed write.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-health-summary |
| MCP tool | crm_health_summary on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns 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.
This endpoint takes an empty body: {}.
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_job_change_apply
Write the new job title and company from pending CRM job changes into the CRM records; in Salesforce a contact may be moved to the new company’s account, created if needed. 1 credit per record written, refunded if the CRM does not accept it. In the app the user approves the cost first.
Apply pending job changes to the connected CRM: write the new job title and company into the CRM records, after the user approves the cost. Use job change ids from the CRM job changes list.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-job-change-apply |
| MCP tool | crm_job_change_apply on https://mcp.prospeo.io |
| Effect | Deletes or removes data. |
| Credits | Can charge credits. At most 1 credits per item. The response’s charge field reports what was charged. |
| Permission | Edit & push CRM records (crm.edit_and_push) |
| Confirmation | Recommended: MCP clients should confirm with the user before calling. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
job_change_ids | array of string | Yes | Job change ids from the CRM job changes list (CRM-only entries). Up to 25 items. |
record_ids | array of string | No | Only these CRM records of those job changes; leave empty for every pending record. Up to 100 items. |
retry_unconfirmed | boolean | No | Write again records the CRM never confirmed. Only when the user asked to retry them. Default false. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_job_changes_list
Pending job changes for selected CRM people (old and new title and company), with the ids needed to apply them to the CRM.
List the pending job changes behind selected people in the connected CRM: who changed jobs, from what title and company to what, when it was detected, and the job change ids needed to apply them to the CRM.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-job-changes-list |
| MCP tool | crm_job_changes_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
object_type | string (enum) | Yes | CONTACT, or LEAD for Salesforce leads. One of: CONTACT, LEAD. |
record_ids | array of string | No | CRM record ids from a CRM record search. Up to 1000 items. |
all_matching | boolean | No | Select every record matching segment_ids and search instead of listing ids. Default false. |
segment_ids | array of string | No | With all_matching: only records in these CRM lists or campaigns. Up to 50 items. |
search | string | No | With all_matching: only records whose own text matches these words. People are not matched on their linked company, so for the people at a company pass their record_ids (from crm_record_search linked_people or crm_record_get) instead. Length 0 to 200. |
exclude_record_ids | array of string | No | With all_matching: records to leave out. Up to 1000 items. |
include_leads | boolean | No | Salesforce only: with CONTACT, also include Leads. Default false. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_job_get
Progress and outcome of a CRM Find contact data or Sync job by id, or the recent Find contact data jobs when no id is given.
Show a CRM Find contact data or Sync job’s status, totals and per-record outcomes, or list the recent Find contact data jobs when no job id is given.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-job-get |
| MCP tool | crm_job_get on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
job_id | string | No | A job id returned by Find contact data or Sync. Leave empty to list recent Find contact data jobs; Sync runs are not listed and are read by id. Pattern ^[0-9a-fA-F]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_record_get
One CRM record with its CRM values beside Prospeo’s, field by field, and for a company the people linked to it; Prospeo emails and mobiles the team has not revealed stay hidden.
Show one record from the connected CRM with its values beside Prospeo’s, field by field, and which differ. Emails and mobile numbers are never shown, from the CRM or from Prospeo: only whether each side has one, and for a Prospeo value the team has not revealed, what revealing it costs. For a company, also lists its people.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-record-get |
| MCP tool | crm_record_get on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
record_id | string | Yes | The CRM record id from a CRM record search. Pattern ^[0-9a-fA-F]{24}$. |
object_type | string (enum) | Yes | The record’s object type, as returned by the search. One of: CONTACT, LEAD, COMPANY, ACCOUNT. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_record_search
Search the connected CRM’s contacts, leads, companies or accounts by words or CRM list, 10 per page, with whether each is in Prospeo, has data available or a pending job change.
Search the connected HubSpot or Salesforce records (contacts, leads, companies or accounts) by words or CRM list, 10 per page, with each record’s name, title, company, owner and lifecycle and whether it is in Prospeo, has an email or mobile available, differs from Prospeo, has a pending job change or duplicates.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-record-search |
| MCP tool | crm_record_search on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Page-based: 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
object_type | string (enum) | Yes | CONTACT or COMPANY for HubSpot; LEAD, CONTACT or ACCOUNT for Salesforce. One of: CONTACT, LEAD, COMPANY, ACCOUNT. |
search | string | No | Words to find in the record’s own text: a person’s name, title or email, or a company’s name or domain. People are not matched on their linked company, so a CONTACT or LEAD search with a company’s name also lists the people linked to the companies it names, under linked_people. Length 0 to 200. |
segment_ids | array of string | No | Only records in these CRM lists or campaigns, ids from the CRM segment list. Up to 50 items. |
include_leads | boolean | No | Salesforce only: with CONTACT, also include Leads. Default false. |
page | integer | No | Page number, starting at 1. From 1 to 2000. Default 1. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_segment_list
The connected CRM’s lists (HubSpot) or campaigns and list views (Salesforce), with sizes and ids for searching.
List the connected CRM’s segments: HubSpot lists, Salesforce campaigns and list views, with their object type, whether they are static or active, their size and the ids used to search or filter by them.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-segment-list |
| MCP tool | crm_segment_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Returns 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.
This endpoint takes an empty body: {}.
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
crm_sync_records
Send Prospeo saved contacts, or a whole list, to the connected CRM: create missing records and fill blank fields; overwrite only the fields the user asked to. Free. In the app the user approves the preview first.
Send Prospeo saved contacts, or a whole Prospeo list, to the connected CRM after the user approves the preview: create missing records, fill blank fields, and overwrite only the fields the user asked to. Optionally add them to a static CRM list or campaign. Uses no credits. More than 25 contacts run as a background job. Execution refuses if more contacts would be sent than the approved preview showed.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/crm-sync-records |
| MCP tool | crm_sync_records on https://mcp.prospeo.io |
| Effect | Deletes or removes data. |
| Credits | Free, uses no credits. |
| Permission | Edit & push CRM records (crm.edit_and_push) |
| Confirmation | Recommended: MCP clients should confirm with the user before calling. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
contact_ids | array of string | No | Prospeo saved contact ids to send to the CRM. Up to 1000 items. |
list_id | string | No | Or a Prospeo list id: send every contact in that list. Pattern ^[0-9a-fA-F]{24}$. |
fields | array of string (enum) | Yes | Which Prospeo fields to write into the CRM. Up to 8 items. Items one of: person_first_name, person_last_name, person_job_title, person_work_email, person_mobile, company_name, company_website, company_country. |
overwrite_fields | array of string (enum) | No | Fields that should replace a value the CRM already has. Every other field only fills blanks. Only when the user asked to overwrite. Up to 8 items. Items one of: person_first_name, person_last_name, person_job_title, person_work_email, person_mobile, company_name, company_website, company_country. |
create_as | string (enum) | No | Salesforce only: create new people as Leads or Contacts. One of: LEAD, CONTACT. |
add_to_segment_id | string | No | Optional static CRM list or campaign to add the records to. Pattern ^[0-9a-fA-F]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
integration_errors
List sanitized errors for one accessible integration.
Retrieve paginated error-log entries (message + timestamp) for one connected integration, for troubleshooting why a sync or push is failing (rate limits, bad credentials, malformed data).
| Endpoint | POST https://api.prospeo.io/api/v2/tools/integration-errors |
| MCP tool | integration_errors on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View push logs (integration.push_logs.view) |
| Confirmation | Not needed. |
| Pagination | Page-based: 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | From 1 to any. Default 1. |
type | string (enum) | Yes | One of: outreach, salesloft, lemlist, smartlead, instantly, woodpecker, reply, salesforge, emailbison, hubspot, pipedrive, salesforce, activecampaign, zoho, close, monday, justcall, slack. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
integrations_status
Get connection state and sanitized events for one integration.
Get one named integration’s connection detail: state (connected/disconnected/failing), connected-as identity (API key shown only as its last 6 characters, or the OAuth account email), whether it needs re-consent for new OAuth scopes, and its recent event-log activity. Use to answer ‘is HubSpot connected’ or ‘what happened with our Salesforce integration’ for an integration the user names.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/integrations-status |
| MCP tool | integrations_status on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | Connect & disconnect (integration.connect_disconnect) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
integration | string (enum) | Yes | One of: outreach, salesloft, lemlist, smartlead, instantly, woodpecker, reply, salesforge, emailbison, hubspot, pipedrive, salesforce, activecampaign, zoho, close, monday, justcall, slack. |
pagination | object | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
push_history
List accessible integration push history with pagination.
List past data pushes to CRM/sales-tool integrations — one provider or one globally ordered page across all — each with record count, status, timing, credits spent, and whether a CSV download is ready. Use to answer ‘what did we push to HubSpot’ or to find a background_process_oid for a push download.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/push-history |
| MCP tool | push_history on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| Confirmation | Not needed. |
| Pagination | Page-based: 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | From 1 to any. Default 1. |
integration | string | No | Optional integration type filter (e.g., ‘smartlead’, ‘hubspot’) Length 1 to any. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.