Notifications

Get All User Notifications

get

Get notifications for a specific user.

Args:

user (UserProfile): The user profile dependency.
organization (Organization): The organization dependency.
notification_service (NotificationService): The notification service dependency

Returns:

list[UserNotificationBase]: The list of notifications for the user.

Responses

200

Successful Response

application/json

get

HTTPcURLJavaScriptPython

GET /notifications/ HTTP/1.1
Host: 
Accept: */*

200

Successful Response

[]

Delete Notification

delete

Delete a notification by its ID.

Args:

notification_id (str): The ID of the notification to delete.
user (UserProfile): The user profile dependency.
notification_service (NotificationService): The notification service dependency
created_at (datetime.datetime): The created at date of the notification.

Returns:

dict: The response indicating the success of the deletion.

Path parameters

notification_idstring · uuidRequired

Query parameters

created_atstring · date-timeRequired

Responses

200

Successful Response

application/json

Responseobject · ResponseDeleteNotificationNotificationsNotificationIdDelete

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /notifications/{notification_id}?created_at=2025-08-28T22%3A27%3A42.301Z HTTP/1.1
Host: 
Accept: */*

{}

Update Notification

patch

Update a notification.

Path parameters

notification_idstring · uuidRequired

Query parameters

created_atstring · date-timeRequired

Body

anyOptional

Responses

200

Successful Response

application/json

Responseobject · ResponseUpdateNotificationNotificationsNotificationIdPatch

422

Validation Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /notifications/{notification_id}?created_at=2025-08-28T22%3A27%3A42.301Z HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*

{}

Delete All User Notifications

delete

Delete all notifications for a specific user.

Args:

user (UserProfile): The user profile dependency.
organization (Organization): The organization dependency
notification_service (NotificationService): The notification service dependency

Returns:

dict: The response indicating the success of the deletion.

Responses

200

Successful Response

application/json

Responseobject · ResponseDeleteAllUserNotificationsNotificationsAllDelete

delete

HTTPcURLJavaScriptPython

DELETE /notifications/all/ HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{}

Get Users From Org By Role

post

Get users from organization by role.

Path parameters

notification_idstring · uuidRequired

Query parameters

role_namestringRequired

Responses

200

Successful Response

application/json

Responseobject · ResponseGetUsersFromOrgByRoleNotificationsNotificationIdPost

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /notifications/{notification_id}/?role_name=text HTTP/1.1
Host: 
Accept: */*

{}