Notifications
| Tool | What it does |
|---|---|
notifications_list | List the caller’s notification feed, unread badge, and unread group counts. |
notifications_mark_all_read | Mark the caller’s entire notification feed as read. |
notifications_mark_read | Mark 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/notifications-list |
| MCP tool | notifications_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 | Cursor-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.
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string (enum) | No | One of: all, unread. Default "all". |
group | string | No | Length 0 to 80. |
query | string | No | Length 0 to 200. |
cursor | string | No | Length 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/notifications-mark-all-read |
| MCP tool | notifications_mark_all_read 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.
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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/notifications-mark-read |
| MCP tool | notifications_mark_read 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 |
|---|---|---|---|
ids | array of string | No | |
all_visible | boolean | No | Default false. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.