SnozeDevelopers
API referenceNotifications

Count the caller's unread notifications

Returns how many unread, inbox-visible notifications are addressed to the caller, optionally restricted to one `workspaceId`. Any authenticated caller may read their own count; passing `workspaceId` requires `workspace:read` in that workspace.

GET
/v1/notifications/unread-count

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.

Query Parameters

workspaceId?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/notifications/unread-count'
Example Response
{  "data": {    "count": 0  }}

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.

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.