Skip to content

Notifications

The Notifications router manages user notifications (e.g., processing complete, errors, system messages).


List notifications for the authenticated user, ordered by most recent first.

Auth: Required

Query ParamTypeRequiredDescription
limitintegerNoMax notifications to return (default: 50)

Response: NotificationResponse[]

[
{
"id": "1",
"user_id": "550e8400-...",
"title": "Processing Complete",
"message": "Your video 'Product Demo' has finished processing.",
"type": "success",
"is_read": 0,
"created_at": "2025-01-15T10:10:00"
}
]
Terminal window
curl https://api.lynxvizion.com/api/notifications \
-H "Authorization: $LVZ_KEY"

Get the count of unread notifications.

Auth: Required

Response:

{
"count": 3
}
Terminal window
curl https://api.lynxvizion.com/api/notifications/unread-count \
-H "Authorization: $LVZ_KEY"

PATCH /notifications/{notification_id}/read

Section titled “PATCH /notifications/{notification_id}/read”

Mark a single notification as read.

Auth: Required

Path ParamTypeRequiredDescription
notification_idstringYesNotification ID

Response:

{ "ok": true }
Terminal window
curl -X PATCH https://api.lynxvizion.com/api/notifications/1/read \
-H "Authorization: $LVZ_KEY"

Mark all unread notifications as read.

Auth: Required

Response:

{
"ok": true,
"updated": 3
}
Terminal window
curl -X POST https://api.lynxvizion.com/api/notifications/read-all \
-H "Authorization: $LVZ_KEY"

Delete a notification.

Auth: Required

Path ParamTypeRequiredDescription
notification_idstringYesNotification ID

Response:

{ "ok": true }
Terminal window
curl -X DELETE https://api.lynxvizion.com/api/notifications/1 \
-H "Authorization: $LVZ_KEY"