internal

List User Notification Preferences

A user's effective preference per notification type, for admin review.

get/internal/notifications/users/{user_id}/preferences

Request

  • Base URL
    https://api.kobaltlabs.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.kobaltlabs.com/internal/notifications/users/{user_id}/preferences
  • Auth
    none declared

Path parameters

user_idstring uuid required

Response

Successful Response

notification_typestring required
labelstring required
descriptionstring required
required_permissionstring nullable required
permittedboolean required
enabledboolean required
supports_assigned_scopeboolean required
assigned_scope_labelstring nullable required
scope'all' | 'assigned' required

How widely a user wants to receive a (scope-supporting) notification.

ALL means every event of this type at the company; ASSIGNED narrows it to the subset that concerns the user. What "assigned" resolves to is defined by the definition's AssignedScopeSpec.kind.

default_scope'all' | 'assigned' required

How widely a user wants to receive a (scope-supporting) notification.

ALL means every event of this type at the company; ASSIGNED narrows it to the subset that concerns the user. What "assigned" resolves to is defined by the definition's AssignedScopeSpec.kind.

Changes

No recorded changes to this operation across all 8 revisions of this API.