Imports and exports
| Tool | What it does |
|---|---|
csv_enrichment_list | List accessible CSV enrichment jobs with filters and pagination. |
export_contacts | Export the frozen contact selection with the owner’s previewed billing. |
get_job_status | Poll the owner’s background job view for progress and completion status. |
import_history | Page through the caller’s own record-import history and current import jobs. |
import_progress | Get the latest progress and safe completion report for one caller-owned record import. |
csv_enrichment_list
List accessible CSV enrichment jobs with filters and pagination.
List CSV enrichment jobs (people or company file uploads) for the team — filename search, status/type filters, pagination — each item carrying its stats and final credit cost breakdown. Use to answer ‘where’s my CSV job at’ or to find a background_process_oid to check status or download results.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/csv-enrichment-list |
| MCP tool | csv_enrichment_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 | 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. |
search | string | No | |
type | string (enum) | No | One of: PEOPLE, COMPANIES. |
user_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
export_contacts
Export the frozen contact selection with the owner’s previewed billing.
Export a set of people (or companies, via the parallel company endpoint) — chosen explicitly by id or as a bulk selection over a search/list, up to 20,000 records — to a CSV file. The result carries a durable file id, the file name and the row count (never a signed link); the persistent in-chat Download button mints a fresh link on every click.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/export-contacts |
| MCP tool | export_contacts on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Can charge credits. At most 1 credits per item. The response’s charge field reports what was charged. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
source | string (enum) | Yes | Where the records come from: FROM_LIST for people in a saved list, FROM_SEARCH for people picked from search results. This tool has no list id argument; a list is chosen with filter_config_token. One of: FROM_SEARCH, FROM_LIST, FROM_EXTENSION_WEBSITE, FROM_EXTENSION_LINKEDIN, FROM_SIGNALS, FROM_ASSISTANT, OTHER. |
filter_config_token | string | No | Chooses the list to export: the filter_config_token returned when the saved list is read (find the list by name first, then read it). Send it together with select_type. |
select_type | string | No | How many records to take from the list chosen by filter_config_token: 20K for every record, up to 20,000, or CUSTOM_ followed by a number from 1 to 20000 for the first that many. Send it whenever filter_config_token is sent. |
operation | ”EXPORT_TO_CSV” | No | Default "EXPORT_TO_CSV". |
person_oids | array of string | No | Exact people to export, taken from earlier results: at least 2 and at most 2500. Not needed when a whole list is chosen with filter_config_token. |
manually_excluded_person_oids | array of string | No | People to leave out of a selection made with filter_config_token. Omit unless the user named people to exclude. |
max_person_per_company | integer | No | From 1 to any. |
waterfall_email | boolean | No | Default false. |
waterfall_mobile | boolean | No | Default false. |
column_to_export | array of string | No | |
profile_field_oids | array of string | No | Up to 200 items. |
request_key | string | No | Length 8 to 100. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
get_job_status
Poll the owner’s background job view for progress and completion status.
Get the status, progress percentage, remaining-time estimate, and result link for one background job by its id. Use to check on or report progress of an export, push, or other long-running operation the user previously started.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/get-job-status |
| MCP tool | get_job_status 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 |
|---|---|---|---|
background_process_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
import_history
Page through the caller’s own record-import history and current import jobs.
Page through this user’s CSV import history, newest first (25/page) — per-batch counters (rows, contacts created, records updated, emails revealed, errors) plus any in-flight or failed live import jobs on page 1. Use to answer “where’s my import at” or to find a batch worth resuming.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/import-history |
| MCP tool | import_history on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | Import records (records.import) |
| 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 1000000. Default 1. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
import_progress
Get the latest progress and safe completion report for one caller-owned record import.
Poll the live progress of one in-flight or finished CSV import run by its upload id — ticking counters while running, the full outcome report once COMPLETED, or a clean toast-safe failure reason (with resume eligibility) if it failed.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/import-progress |
| MCP tool | import_progress on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | Import records (records.import) |
| 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 |
|---|---|---|---|
upload_oid | string | Yes | Length 1 to 128. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.