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.
Authorizations
OAuth2passwordRequired
Token URL:
Responses
200

Successful Response

application/json
get
/notifications/
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.
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
notification_idstring · uuidRequired
Query parameters
created_atstring · date-timeRequired
Responses
200

Successful Response

application/json
delete
/notifications/{notification_id}

Update Notification

patch

Update a notification.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
notification_idstring · uuidRequired
Query parameters
created_atstring · date-timeRequired
Body
read_atstring · date-timeRequired
Responses
200

Successful Response

application/json
patch
/notifications/{notification_id}

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.
Authorizations
OAuth2passwordRequired
Token URL:
Responses
200

Successful Response

application/json
delete
/notifications/all/
200

Successful Response

Get Users From Org By Role

post

Get users from organization by role.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
notification_idstring · uuidRequired
Query parameters
role_namestringRequired
Responses
200

Successful Response

application/json
post
/notifications/{notification_id}/

Last updated

Was this helpful?