Skip to main content
GET
Get notification settings
Read notification preferences - weekly reports, monthly audits, new opportunities, resource-usage warnings - plus the list of client-report recipients and the cadence each one receives.
These settings are org-wide: one set per organization, shared by every brand in it. teamId only identifies which organization to use. Reading requires any team member. The GET route auto-creates default settings on first read.

GET response fields

reportLinkPassword, when set, has: A fixed setting saved without a usable password is stored as null (off). Each entry in reportRecipients has: See also: Update Notification Settings.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Query Parameters

teamId
string

Team ID used to resolve the organization these org-wide settings belong to

Response

200 - application/json

Default Response

weeklyReports
boolean
monthlyAudits
boolean
weeklyReportTeamIds
string[] | null
monthlyAuditTeamIds
string[] | null
newOpportunities
boolean
resourceUsageWarning
boolean
clientReportsEnabled
boolean
reportRecipients
object[]
defaultReportTemplateSlug
string | null
whiteLabelAvailable
boolean