Skip to content

users_notification_settings_retrieve

GET
/api/users/notification-settings
curl --request GET \
--url https://example.com/api/users/notification-settings \
--header 'Authorization: Bearer <token>'

Handle user notification settings views.

Media typeapplication/json

Serializer for UserNotificationSettings model.

object
id
required
string format: uuid
email_submission_enabled

Enable email notifications for submission events

boolean
email_workspace_added_enabled

Enable email notifications when added to a new workspace

boolean
created_time
required
string format: date-time
last_edited_time
required
string format: date-time
defaults
required

Return the default values for notification settings.

Parameters

obj : UserNotificationSettings The notification settings instance (not used, but required by SerializerMethodField).

Returns

dict A dictionary containing the default values for all notification settings.

object
key
additional properties

Example generated

{
"email_submission_enabled": true,
"email_workspace_added_enabled": true
}