Notifications

Notifications are workspace-scoped in-app alerts (e.g. mentions, assignments). All endpoints are under /v1/workspaces/:workspaceId/notifications. Auth: Bearer token + x-workspace-id.

GET /v1/workspaces/:workspaceId/notifications

List notifications for the current user in the workspace.

Query parameters:

Param	Type	Description
limit	number	1–50, default 20.
cursor	string	Pagination cursor from previous response.

Response (200): Object with:

• items — Array of notification objects: id, type, referenceId, title, readAt, createdAt.
• nextCursor — Optional; present when more results exist. Send as cursor for the next page.

Example:

curl -X GET "https://api.inboxops.app/v1/workspaces/ws-123/notifications?limit=20" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

---

GET /v1/workspaces/:workspaceId/notifications/unread-count

Get the number of unread notifications for the current user in the workspace.

Response (200): { "count": number }

Example:

curl -X GET https://api.inboxops.app/v1/workspaces/ws-123/notifications/unread-count \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

---

PATCH /v1/workspaces/:workspaceId/notifications/:notificationId/read

Mark a notification as read.

Body: None (or empty JSON).

Response (200): Updated notification or success.

Example:

curl -X PATCH https://api.inboxops.app/v1/workspaces/ws-123/notifications/NOTIFICATION_UUID/read \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

Errors use the standard shape: key, params, fallbackMessage. The API may include x-correlation-id in the response for debugging.