Account and billing
| Tool | What it does |
|---|---|
get_account_context | Get who the caller is: display name, role, IANA timezone, and which CRM/outreach integrations are connected. |
invoice_download | Prepare an authorized invoice or receipt download. |
invoice_list | List the team’s invoices and receipts, one page at a time. |
member_list | Resolve active teammate names to public user IDs for assignment. |
subscription_get | Get the team’s current subscription, billing period, credits, and renewal information. |
webhook_event_types_list | List every event type a webhook subscription can receive. |
webhook_subscription_create | Subscribe an HTTPS URL to chosen event types, or to all events. |
webhook_subscription_delete | Delete one webhook subscription. |
webhook_subscription_list | List the team’s webhook subscriptions with their last delivery failure. |
webhook_subscription_update | Change a webhook subscription’s URL or event types, or pause and resume it. |
get_account_context
Get who the caller is: display name, role, IANA timezone, and which CRM/outreach integrations are connected.
Get the current user’s identity, role, timezone, and a summary of which integrations are connected. Use to orient the assistant about who it is talking to before answering account or settings questions. Not yet buildable from a single endpoint.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/get-account-context |
| MCP tool | get_account_context 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.
invoice_download
Prepare an authorized invoice or receipt download.
Get a signed Stripe download URL for one of the team’s invoices or its payment receipt, by invoice id.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/invoice-download |
| MCP tool | invoice_download on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View billing (billing.read) |
| 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 |
|---|---|---|---|
type | string | Yes | Pattern ^(invoice|receipt)$. |
invoice_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.
invoice_list
List the team’s invoices and receipts, one page at a time.
List the team’s paid invoices and receipts (date, status, invoice number, description, price), paginated newest first. Call the shared billing endpoint with type fixed to ‘invoices_and_receipts’.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/invoice-list |
| MCP tool | invoice_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View billing (billing.read) |
| 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. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
member_list
Resolve active teammate names to public user IDs for assignment.
List every active teammate’s name, email, and oid, for use as an assignee/owner picker. Use to resolve a name the user typed to a user_oid before task_reassign, or when discussing a deal’s owners.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/member-list |
| MCP tool | member_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.
subscription_get
Get the team’s current subscription, billing period, credits, and renewal information.
Get the team’s current subscription: plan, billing period, price, seat usage, credit balances (current/total/rollover/special), any active coupon, scheduled renewal/downgrade/cancellation, and past-due phone-number risk if payment is overdue. Use to check plan/billing status before discussing upgrades, downgrades, or credits.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/subscription-get |
| MCP tool | subscription_get on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View billing (billing.read) |
| 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.
webhook_event_types_list
List every event type a webhook subscription can receive.
List every event type a webhook subscription can receive (deals, contacts, accounts, lists, sequences, emails, replies, calls, meetings, recordings, tasks, forms, imports, enrichment, mailboxes, CRM changes), each with its family and the record kinds it is about.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/webhook-event-types-list |
| MCP tool | webhook_event_types_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View API keys (api.keys.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.
This endpoint takes an empty body: {}.
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
webhook_subscription_create
Subscribe an HTTPS URL to chosen event types, or to all events.
Subscribe an HTTPS URL to chosen event types, or to all events, so Prospeo POSTs each event to it in real time. Each POST is JSON signed with HMAC-SHA256 (X-Prospeo-Signature: v1=hex of “timestamp.body”, timestamp in X-Prospeo-Timestamp), carries an opaque event id in X-Prospeo-Delivery and public ids only. A delivery times out after 5 seconds and is retried once, then dropped and recorded as the subscription’s last failure. An event can arrive twice (drop repeats by X-Prospeo-Delivery) and is not replayed. The signing secret is returned only in this result. At most 20 subscriptions per team.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/webhook-subscription-create |
| MCP tool | webhook_subscription_create on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create API keys (api.keys.create) |
| 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 |
|---|---|---|---|
url | string | Yes | HTTPS URL that receives the POSTs Length 1 to 2000. |
all_events | boolean | No | Receive every event type, including ones added later Default false. |
event_types | array of string | No | Event types from webhook_event_types_list Up to 200 items. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
webhook_subscription_delete
Delete one webhook subscription.
Delete one webhook subscription the user names explicitly.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/webhook-subscription-delete |
| MCP tool | webhook_subscription_delete on https://mcp.prospeo.io |
| Effect | Deletes or removes data. |
| Credits | Free, uses no credits. |
| Permission | Delete API keys (api.keys.delete) |
| 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 |
|---|---|---|---|
webhook_subscription_oid | string | Yes | webhook_subscription_oid from the list or create result Length 24 to 24. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
webhook_subscription_list
List the team’s webhook subscriptions with their last delivery failure.
List the team’s webhook subscriptions: each URL, its event types or all events, whether it is enabled, and its last delivery failure (when, which event type, why). Never returns signing secrets.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/webhook-subscription-list |
| MCP tool | webhook_subscription_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | View API keys (api.keys.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.
This endpoint takes an empty body: {}.
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
webhook_subscription_update
Change a webhook subscription’s URL or event types, or pause and resume it.
Change one webhook subscription’s URL or event types, switch it to all events, or pause and resume it with enabled. The signing secret does not change.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/webhook-subscription-update |
| MCP tool | webhook_subscription_update on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create API keys (api.keys.create) |
| 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 |
|---|---|---|---|
webhook_subscription_oid | string | Yes | webhook_subscription_oid from the list or create result Length 24 to 24. |
url | string | No | Length 1 to 2000. |
all_events | boolean | No | |
event_types | array of string | No | Event types from webhook_event_types_list Up to 200 items. |
enabled | boolean | No | false pauses deliveries without deleting |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.