Get notification settings
curl --request GET \
--url https://api.snowseo.com/v3/settings/notifications \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.snowseo.com/v3/settings/notifications"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.snowseo.com/v3/settings/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/settings/notifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/settings/notifications"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.snowseo.com/v3/settings/notifications")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"weeklyReports": true,
"monthlyAudits": true,
"weeklyReportTeamIds": [
"<string>"
],
"monthlyAuditTeamIds": [
"<string>"
],
"newOpportunities": true,
"resourceUsageWarning": true,
"clientReportsEnabled": true,
"reportRecipients": [
{}
],
"defaultReportTemplateSlug": "<string>",
"reportLinkPassword": {},
"whiteLabelAvailable": true
}Settings
Notification Settings
Manage a brand’s email notifications, client-report recipients, and their frequencies.
GET
/
v3
/
settings
/
notifications
Get notification settings
curl --request GET \
--url https://api.snowseo.com/v3/settings/notifications \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.snowseo.com/v3/settings/notifications"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.snowseo.com/v3/settings/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/settings/notifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/settings/notifications"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.snowseo.com/v3/settings/notifications")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"weeklyReports": true,
"monthlyAudits": true,
"weeklyReportTeamIds": [
"<string>"
],
"monthlyAuditTeamIds": [
"<string>"
],
"newOpportunities": true,
"resourceUsageWarning": true,
"clientReportsEnabled": true,
"reportRecipients": [
{}
],
"defaultReportTemplateSlug": "<string>",
"reportLinkPassword": {},
"whiteLabelAvailable": true
}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.
A
See also: Update Notification Settings.
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
| Field | Description |
|---|---|
weeklyReports | Send the weekly performance report. |
monthlyAudits | Send the monthly site audit. |
weeklyReportTeamIds | Brands the weekly report covers, or null for all brands. |
monthlyAuditTeamIds | Brands the monthly audit covers, or null for all brands. |
newOpportunities | Notify on new opportunities. |
resourceUsageWarning | Warn when resource/credit usage is running low. |
clientReportsEnabled | Master switch for client-report delivery. |
reportRecipients | Array of client-report recipients (see below). At most 10 are kept; extra entries are dropped on save. |
defaultReportTemplateSlug | Report template used when a recipient has no per-brand choice, or null for the built-in default. |
reportLinkPassword | Password gate on hosted report links: an object (see below), or null when off. |
whiteLabelAvailable | Read-only flag: whether the plan allows white-label reports. |
reportLinkPassword, when set, has:
| Field | Description |
|---|---|
mode | auto generates a new password for each report link, so links are gated too. fixed uses one password you choose for every link. |
password | Only for fixed: the password, returned as stored. Omit it on save to keep the current one. |
hint | Optional hint shown to the viewer. |
fixed setting saved without a usable password is stored as null (off).
Each entry in reportRecipients has:
| Field | Description |
|---|---|
email | Recipient email (lowercased). |
weekly | Include in the weekly report. |
monthly | Include in the monthly report. |
whiteLabel | Send this recipient the white-labeled version. |
teamIds | Brands this recipient receives reports for. An empty list delivers nothing. |
reports | Optional map of teamId to { "kind": "template", "slug" } or { "kind": "report", "reportId" }. A saved report only applies to the brand it was built in. |
sendTime | Optional HH:MM (24-hour, 15-minute steps), read in timeZone. Defaults to 09:00. |
timeZone | Optional IANA timezone for the whole schedule. Defaults to UTC. |
weeklyDay | Optional weekday for weekly reports, 0 (Sunday) to 6. Defaults to Monday. |
monthlyDay | Optional day of month for monthly reports, 1 to 31 (shorter months send on their last day). Defaults to the 1st. |
Authorizations
bearerAuthapiKey
Your SnowSEO API key (sk_...).
Query Parameters
Team ID used to resolve the organization these org-wide settings belong to
Response
200 - application/json
Default Response
Was this page helpful?

