SnozeDevelopers
API referenceNotifications

List the caller's notification inbox

Returns the inbox-visible notifications addressed to the caller, newest first, optionally narrowed to one `workspaceId` or to `scope=account`, and to unread only or including archived ones. Any authenticated caller sees only their own notifications; passing `workspaceId` additionally requires `workspace:read` there. Paginated: pass `limit` and the `cursor` taken from the previous response's `nextCursor`. A malformed cursor, a non-integer `limit`, a non-boolean flag, or an unrecognized `scope` is a validation error.

GET
/v1/notifications
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Query Parameters

workspaceId?string|null
scope?string|null
limit?string|null
cursor?string|null
unreadOnly?string|null
includeArchived?string|null

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/notifications"
{  "data": {    "notifications": [      {        "id": "string",        "scope": "account",        "workspaceId": "string",        "recipientUserId": "string",        "recipientEmail": "string",        "actorUserId": "string",        "actorDisplayName": "string",        "actorAvatarUrl": "string",        "category": "collaboration",        "kind": "comment",        "title": "string",        "body": "string",        "target": {          "type": "workspace",          "workspaceId": "string"        },        "action": {          "type": "open_target"        },        "data": {},        "surfaceId": "string",        "itemId": "string",        "blockId": "string",        "commentId": "string",        "preview": "string",        "surfaceTitle": "string",        "readAt": "string",        "archivedAt": "string",        "createdAt": "string"      }    ],    "nextCursor": "string"  }}