SnozeDevelopers
API referenceNotifications

Mark notifications read in a workspace

Stamps `readAt` on the caller's unread notifications in this workspace — the ids in `notificationId` or `notificationIds`, or with `all` every unread one — and appends a read event to the workspace log. Requires `workspace:read` in that workspace; a body with neither ids nor `all` is a validation error, and a single id that matches nothing readable is not found. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/notifications/read

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

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

Path Parameters

workspaceId*string

Request Body

application/json
  1. body
notificationId?|null
notificationIds?array<>|null
all?boolean|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/notifications/read' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "notificationIds": [      "string"    ],    "readAt": "string"  }}

List the caller's notifications in one workspace

Returns the caller's notifications for a single workspace — the same inbox listing pinned to workspace scope. Requires `workspace:read` in that workspace. Pass `limit` to cap the page and `unreadOnly` to hide already-read entries; a non-integer `limit` or a non-boolean flag is a validation error.

Mark inbox notifications read

The account-level twin of the workspace mark-read: stamps `readAt` on the caller's unread notifications across every workspace, or within one when `workspaceId` is given. A body with neither ids nor `all` is a validation error, and a single id that matches nothing readable is not found. Scoping to a `workspaceId` requires `workspace:read` there and accepts an `Idempotency-Key` header to make retries safe.