List Notifications
The caller's in-app notifications (their own, the workspace's, and the admins' for owners and admins), unread first, then newest first, with the unread count. Written by the core when a mailbox or sending domain auto-pauses or its health drops, a signal rule fires, an export is ready, a research batch finishes, a webhook endpoint is auto-disabled or a privacy export completes. Kept `NOTIFICATIONS_RETENTION_DAYS` (default 90).
API key access
notifications:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/notificationsAccess token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Query Parameters
Only unread notifications (default false)
Default 50
int641 <= value <= 200next_cursor of the previous page
length <= 64Header Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/notifications?unread_only=true&limit=1&cursor=string" \ -H "X-Workspace-Id: string"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "mailbox_paused",
"severity": "info",
"title": "Export ready: reachout-leads-20261019-101500.csv",
"body": "string",
"link": "string",
"resource_type": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"personal": true,
"read_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string",
"unread_count": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}