Skip to Content
Tools referenceImports and exports

Imports and exports

ToolWhat it does
csv_enrichment_listList accessible CSV enrichment jobs with filters and pagination.
export_contactsExport the frozen contact selection with the owner’s previewed billing.
get_job_statusPoll the owner’s background job view for progress and completion status.
import_historyPage through the caller’s own record-import history and current import jobs.
import_progressGet 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/csv-enrichment-list
MCP toolcsv_enrichment_list on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationPage-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.

ParameterTypeRequiredDescription
pageintegerNoFrom 1 to any. Default 1.
searchstringNo
typestring (enum)NoOne of: PEOPLE, COMPANIES.
user_oidstringNoPattern ^[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.

EndpointPOST https://api.prospeo.io/api/v2/tools/export-contacts
MCP toolexport_contacts 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.
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
sourcestring (enum)YesWhere 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_tokenstringNoChooses 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_typestringNoHow 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”NoDefault "EXPORT_TO_CSV".
person_oidsarray of stringNoExact 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_oidsarray of stringNoPeople to leave out of a selection made with filter_config_token. Omit unless the user named people to exclude.
max_person_per_companyintegerNoFrom 1 to any.
waterfall_emailbooleanNoDefault false.
waterfall_mobilebooleanNoDefault false.
column_to_exportarray of stringNo
profile_field_oidsarray of stringNoUp to 200 items.
request_keystringNoLength 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/get-job-status
MCP toolget_job_status on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
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
background_process_oidstringYesMongoDB 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/import-history
MCP toolimport_history on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionImport records (records.import)
ConfirmationNot needed.
PaginationPage-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.

ParameterTypeRequiredDescription
pageintegerNoFrom 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/import-progress
MCP toolimport_progress on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionImport records (records.import)
ConfirmationNot needed.
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
upload_oidstringYesLength 1 to 128.

Response

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

Last updated on