Deals
| Tool | What it does |
|---|---|
deal_add_note | Replace a deal’s shared rich-text note. |
deal_bulk_update | Apply exactly one bounded stage, status, tag, owner or scalar update across named deals. |
deal_create | Create a deal through the existing pipeline checks. |
deal_delete | Soft-delete one accessible deal after approval. |
deal_get | Get full detail for one named deal or opportunity by its id: pipeline/stage/status, owners, amount/value and currency (plus home-currency conversion), close date, rotten/idle-day and activity signals, notes, tags, custom fields, and its linked contacts, meetings, and followers. |
deal_link_contact | Link an accessible saved contact to one deal. |
deal_list_by_contact | List the open deals linked to a saved contact. |
deal_lose | Mark one deal lost with the owner’s required reason. |
deal_move_stage | Move a deal through the owner’s stage transition path. |
deal_reopen | Reopen one closed deal into an eligible open stage. |
deal_search | Find deals or opportunities matching filters: pipeline, stage, owner, status (open/won/lost), amount range, close/created/last-activity dates, rotten-only, tags, lost reason, forecast category, source, followers, created-by, exact deal custom-field values, and free text, sorted and paginated. |
deal_timeline | Get one deal’s activity timeline: stage changes, note edits, its own tasks, linked meetings, and every email/call against its linked contacts, newest first. Use to answer ‘what happened on this deal’, ‘when did this deal move to this stage’, ‘has anyone called or emailed about this deal or opportunity recently’. |
deal_update | Patch editable fields on one accessible deal. |
deal_win | Mark one deal won using an eligible won stage. |
lost_reason_list | List the team’s configured reasons a deal can be marked lost (e.g. price, timing, went with competitor), plus whether a custom freeform lost reason is allowed. Use to resolve a lost-reason name to its id before marking a deal lost, or to answer ‘why do deals get marked lost’ / ‘what lost reasons do we track’. |
pipeline_list | List the team’s deal pipelines (sales funnels) and each pipeline’s ordered stages — pipeline names, default flag, stage names, stage type (OPEN/WON/LOST), win probability, rot window. Use to resolve a pipeline or deal-stage name to its id before creating, updating, or moving a deal, or to answer ‘what pipelines/stages do we have for deals’. |
deal_add_note
Replace a deal’s shared rich-text note.
Save/update the deal’s single shared, team-wide rich-text notes (last-write-wins, whole record overwrite), optionally resolving @-mentions of teammates. Use to log context, an update, or a note on a named deal.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-add-note |
| MCP tool | deal_add_note on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
notes_rich | string | Yes | |
mention_user_oids | array of string | No | MENTION_SYSTEM.md LAW MN-2 — structured teammate ids the @-editor emits, never scanned from notes_rich text |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_bulk_update
Apply exactly one bounded stage, status, tag, owner or scalar update across named deals.
Apply one declared update operation across a bounded set of deals. Stage, status, tags, and owners reuse existing owner bulk capabilities; scalar field changes are bounded Assistant orchestration over the existing single-deal update capability. Deletion is not supported.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-bulk-update |
| MCP tool | deal_bulk_update on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
operation | string (enum) | Yes | One of: set_stage, set_status, add_tags, set_owners, set_scalars. |
deal_oids | array of string | Yes | Up to 20000 items. |
stage_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
status | string (enum) | No | One of: WON, LOST, REOPEN. |
lost_reason_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
lost_note | string | No | |
tag_oids | array of string | No | |
add_owner_oids | array of string | No | |
remove_owner_oids | array of string | No | |
name | string | No | |
company_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
amount | number | No | |
currency_code | string | No | |
close_date | string | No | |
probability_override | integer | No | From 0 to 100. |
forecast_category | string | No | |
next_step | string | No | |
next_step_date | string | No | |
description | string | No | |
tag_oids_replace | array of string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_create
Create a deal through the existing pipeline checks.
Create a new deal (defaults: team’s default pipeline, first open stage, owner = you, close date = end of the current month, currency = team home). Can create straight into a Won/Lost stage, attach a company, up to 50 contacts, tags, and line items. Use to log a new sales opportunity.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-create |
| MCP tool | deal_create on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
name | string | Yes | Length 1 to 255. |
pipeline_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
stage_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
company_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
contact_oids | array of string | No | |
owner_oids | array of string | No | |
amount | number | No | From 0 to any. |
currency_code | string | No | |
close_date | string | No | |
next_step | string | No | Length 0 to 255. |
next_step_date | string | No | |
description | string | No | |
line_items | array of object | No | |
forecast_category | string (enum) | No | One of: PIPELINE, BEST_CASE, COMMIT, OMITTED, CLOSED. |
tag_oids | array of string | No | |
source | string (enum) | No | Where a deal was created from. One of: UI_FORM, API, IMPORT, WORKFLOW. Default "UI_FORM". |
source_channel | string | No | Length 0 to 200. |
lost_reason_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
lost_note | string | No | |
custom_fields | array of object | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_delete
Soft-delete one accessible deal after approval.
Delete a deal the user names explicitly.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-delete |
| MCP tool | deal_delete on https://mcp.prospeo.io |
| Effect | Deletes or removes data. |
| Credits | Free, uses no credits. |
| 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 |
|---|---|---|---|
deal_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.
deal_get
Get full detail for one named deal or opportunity by its id: pipeline/stage/status, owners, amount/value and currency (plus home-currency conversion), close date, rotten/idle-day and activity signals, notes, tags, custom fields, and its linked contacts, meetings, and followers.
Get full detail for one named deal: pipeline/stage/status, owners, amount and currency (plus home-currency conversion), dates, notes, tags, custom fields, rotten/activity signals, and its linked contacts, meetings, and followers.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-get |
| MCP tool | deal_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 |
|---|---|---|---|
deal_oid | string | Yes | The deal’s public id, taken from a deal search result. A deal’s name is not accepted here. Length 1 to 128. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_link_contact
Link an accessible saved contact to one deal.
Link an existing saved contact to a deal (fluid, no roles, up to 50 contacts per deal). If the deal is on an open stage, this also syncs the contact’s own stage tracking.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-link-contact |
| MCP tool | deal_link_contact on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
contact_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.
deal_list_by_contact
List the open deals linked to a saved contact.
List a contact’s currently OPEN deals (derived purely via the deal-contact join; nothing stored on the contact). Never errors for zero results. Use to answer “does this person have any open deals?” from a contact context.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-list-by-contact |
| MCP tool | deal_list_by_contact 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 |
|---|---|---|---|
contact_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.
deal_lose
Mark one deal lost with the owner’s required reason.
Mark a deal LOST with a required reason (and optional note); lands on the pipeline’s first LOST-type stage unless stage_oid picks a specific one. Reversible via reopening the deal.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-lose |
| MCP tool | deal_lose on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
lost_reason_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
lost_note | string | No | |
stage_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.
deal_move_stage
Move a deal through the owner’s stage transition path.
Move a deal to a different stage (any pipeline). If the target stage is a WON or LOST type, this closes the deal in-place through the same win/lose flow (required-field gating, FX snapshot) instead of just relocating it.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-move-stage |
| MCP tool | deal_move_stage on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
stage_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
lost_reason_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
lost_note | string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_reopen
Reopen one closed deal into an eligible open stage.
Reopen a closed (Won/Lost) deal back onto an open stage — either one the user names explicitly, or the deal’s last open stage / open-stage history / pipeline’s first open stage as a fallback chain.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-reopen |
| MCP tool | deal_reopen on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
stage_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.
deal_search
Find deals or opportunities matching filters: pipeline, stage, owner, status (open/won/lost), amount range, close/created/last-activity dates, rotten-only, tags, lost reason, forecast category, source, followers, created-by, exact deal custom-field values, and free text, sorted and paginated.
Find deals matching structured criteria (pipeline, stage, owner, open/won/lost status, tags, amount range, close date, rotten-only) plus optional free text. Use to answer a filtered lookup like “open deals over $10k owned by X” rather than browsing the full table.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-search |
| MCP tool | deal_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, 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 |
|---|---|---|---|
page | integer | No | 1-based page number. From 1 to any. Default 1. |
per_page | integer | No | Rows per page, 1-100. From 1 to 100. Default 25. |
pipeline_oid | string | No | Restrict to one pipeline. |
scope_me_only | boolean | No | Only deals the caller owns. Default false. |
search | string | No | Free-text match on deal name or linked company name. Length 0 to 500. |
sort_by | string | No | One of: name, amount, close_date, created_at, next_step_date, forecast_category, probability_override, amount_home, weighted_amount, days_in_stage, is_rotten, next_activity_at. An unrecognized value falls back to newest-created-first. Length 0 to 60. |
sort_dir | string (enum) | No | Sort direction. One of: asc, desc. Default "desc". |
stage_oids | array of string | No | Up to 200 items. |
status | string (enum) | No | Single-value status filter (legacy alias for statuses[]). One of: OPEN, WON, LOST, DELETED. |
statuses | array of string (enum) | No | Up to 4 items. Items one of: OPEN, WON, LOST, DELETED. |
owner_oids | array of string | No | Up to 200 items. |
company_oid | string | No | |
amount_min | number | No | From 0 to any. |
amount_max | number | No | From 0 to any. |
close_date_from | string | No | |
close_date_to | string | No | |
close_date_preset | string | No | One of: overdue, month, quarter, later (server-resolved preset). Length 0 to 40. |
created_from | string | No | |
created_to | string | No | |
created_preset | string | No | One of: 7d, 30d, 90d, month, quarter. Length 0 to 40. |
stage_entered_from | string | No | |
stage_entered_to | string | No | |
last_activity_from | string | No | |
last_activity_to | string | No | |
last_activity_preset | string | No | One of: 7d, 30d, stale. Length 0 to 40. |
next_step_from | string | No | |
next_step_to | string | No | |
activity_status | string | No | Length 0 to 40. |
activity_statuses | array of string | No | Up to 10 items. |
rotten_only | boolean | No | Only deals currently flagged rotten. Default false. |
tag_oids | array of string | No | Up to 200 items. |
lost_reason_oid | string | No | |
lost_reason_oids | array of string | No | Up to 200 items. |
forecast_category | string (enum) | No | One of: PIPELINE, BEST_CASE, COMMIT, OMITTED, CLOSED. |
forecast_categories | array of string (enum) | No | Up to 5 items. Items one of: PIPELINE, BEST_CASE, COMMIT, OMITTED, CLOSED. |
forecast_category_is_null | boolean | No | Match deals with no forecast category set (the §7.5 ‘Not set’ door). Default false. |
source | string (enum) | No | One of: UI_FORM, API, IMPORT, WORKFLOW. |
sources | array of string (enum) | No | Up to 4 items. Items one of: UI_FORM, API, IMPORT, WORKFLOW. |
follower_oids | array of string | No | Up to 200 items. |
created_by_oid | string | No | |
created_by_oids | array of string | No | Up to 200 items. |
custom_field_equals | array of object | No | Exact-match conditions on DEAL custom fields, all of which must hold (AND). Each field_oid may appear once. Up to 20 conditions. Up to 20 items. |
account_list_oids | array of string | No | Up to 200 items. |
company_location | string | No | Length 0 to 200. |
company_employee_count_min | integer | No | From 0 to any. |
company_employee_count_max | integer | No | From 0 to any. |
company_industry | string | No | Length 0 to 200. |
company_keywords | string | No | Length 0 to 200. |
company_technologies | array of string | No | Up to 50 items. |
company_funding_stage | string | No | Length 0 to 100. |
filter_group | object | No | §7.3 advanced AND/OR builder — set instead of, never alongside, the flat filters above. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_timeline
Get one deal’s activity timeline: stage changes, note edits, its own tasks, linked meetings, and every email/call against its linked contacts, newest first. Use to answer ‘what happened on this deal’, ‘when did this deal move to this stage’, ‘has anyone called or emailed about this deal or opportunity recently’.
Get a deal’s joined activity stream: stage-change/note-edit history plus its own tasks, linked meetings, and every email/call against its linked contacts, newest first. Use to answer “what’s happened on this deal” questions.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-timeline |
| MCP tool | deal_timeline 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 |
|---|---|---|---|
deal_oid | string | Yes | The deal’s public id. Length 1 to 128. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_update
Patch editable fields on one accessible deal.
Edit fields on an existing deal (name, company, amount/currency, close date, probability override, forecast category, next step, description, line items, tags, custom fields). Team-shared, no field-level permission gate. Use to update deal details the user names explicitly.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-update |
| MCP tool | deal_update on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
name | string | No | Length 0 to 255. |
company_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
amount | number | No | From 0 to any. |
currency_code | string | No | |
close_date | string | No | |
probability_override | integer | No | From 0 to 100. |
forecast_category | string (enum) | No | One of: PIPELINE, BEST_CASE, COMMIT, OMITTED, CLOSED. |
next_step | string | No | Length 0 to 255. |
next_step_date | string | No | |
description | string | No | |
source_channel | string | No | Length 0 to 200. |
line_items | array of object | No | |
tag_oids | array of string | No | |
custom_fields | array of object | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
deal_win
Mark one deal won using an eligible won stage.
Mark a deal WON; lands on the pipeline’s first WON-type stage unless stage_oid picks a specific one. Reversible via reopening the deal.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/deal-win |
| MCP tool | deal_win on https://mcp.prospeo.io |
| Effect | Changes 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 |
|---|---|---|---|
deal_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
stage_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.
lost_reason_list
List the team’s configured reasons a deal can be marked lost (e.g. price, timing, went with competitor), plus whether a custom freeform lost reason is allowed. Use to resolve a lost-reason name to its id before marking a deal lost, or to answer ‘why do deals get marked lost’ / ‘what lost reasons do we track’.
List the team’s configured “deal lost” reasons — name, active flag, display order — plus whether a freeform “Other” reason is allowed. Use to resolve a reason name to its oid before calling deal_lose, or to show what reasons exist.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/lost-reason-list |
| MCP tool | lost_reason_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 |
|---|---|---|---|
include_inactive | boolean | No | Include deactivated lost reasons. False (default) returns only active ones. Default false. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
pipeline_list
List the team’s deal pipelines (sales funnels) and each pipeline’s ordered stages — pipeline names, default flag, stage names, stage type (OPEN/WON/LOST), win probability, rot window. Use to resolve a pipeline or deal-stage name to its id before creating, updating, or moving a deal, or to answer ‘what pipelines/stages do we have for deals’.
List the team’s deal pipelines, each with its full ordered stage set (names, types, win probabilities, rot windows). Use to resolve a pipeline or stage name to its oid before creating, updating, or moving a deal.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/pipeline-list |
| MCP tool | pipeline_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 |
|---|---|---|---|
include_archived | boolean | No | Include archived pipelines. False (default) returns only live pipelines. Default false. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.