Skip to Content
Tools referenceNotifications

Notifications

ToolWhat it does
notifications_listList the caller’s notification feed, unread badge, and unread group counts.
notifications_mark_all_readMark the caller’s entire notification feed as read.
notifications_mark_readMark selected notifications, or the caller’s whole visible feed, as read.

notifications_list

List the caller’s notification feed, unread badge, and unread group counts.

Get a page of the caller’s own notification bell feed (newest first), plus the live unread badge and per-group unread counts. Supports filtering to unread-only, one category group, a text search on title/body, and keyset pagination via an opaque cursor. Use to check what a user has been notified about, or to find notification id(s) before marking them read.

EndpointPOST https://api.prospeo.io/api/v2/tools/notifications-list
MCP toolnotifications_list on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationCursor-based: cursor.

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
filterstring (enum)NoOne of: all, unread. Default "all".
groupstringNoLength 0 to 80.
querystringNoLength 0 to 200.
cursorstringNoLength 0 to 2048.

Response

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

notifications_mark_all_read

Mark the caller’s entire notification feed as read.

Mark the caller’s entire notification feed as read in a single write, advancing their read watermark.

EndpointPOST https://api.prospeo.io/api/v2/tools/notifications-mark-all-read
MCP toolnotifications_mark_all_read on https://mcp.prospeo.io
EffectChanges 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.

This endpoint takes an empty body: {}.

Response

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

notifications_mark_read

Mark selected notifications, or the caller’s whole visible feed, as read.

Mark specific notification(s) read by id, or fold every row currently visible in the feed into the read watermark (all_visible=true — equivalent to notifications_mark_all_read). Use right after the user indicates they’ve seen or handled particular notifications.

EndpointPOST https://api.prospeo.io/api/v2/tools/notifications-mark-read
MCP toolnotifications_mark_read on https://mcp.prospeo.io
EffectChanges 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
idsarray of stringNo
all_visiblebooleanNoDefault false.

Response

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

Last updated on