Skip to main content
GET
Get an internal user's notification settings

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

ID of the internal user

Response

OK

disableInProduct
boolean

DisableInProduct is true when the user has globally disabled in-product notifications; when true it overrides every per-category setting in notifyAbout.

Example:

false

emailSettings
enum<string>

EmailSettings is the user's global email delivery preference: "always" sends every notification email, "not_active" only emails the user when they have no active session, and "no_emails" disables notification emails entirely.

Available options:
always,
not_active,
no_emails
Example:

"not_active"

notifyAbout
object

NotifyAbout maps a notification category to the user's per-channel opt-outs. First-party keys: newClientDirectSignup, newClientActivation, newMessages, paidInvoices, processingInvoices, paymentFailedInvoices, uploadedFiles, signedContracts, newFormResponses, newTeamMemberActivation, assistantMention. Every notification setting declared by the portal's installed apps appears under its camelCased label (the app's declared default when the user hasn't customized it), with appId and notificationSettingId identifying the app setting it belongs to.

object
string
Example:

"internalUserNotificationSettings"