Skip to main content
GET
/
api
/
notifications
/
preferences
Get notification preferences
curl --request GET \
  --url https://api.example.com/api/notifications/preferences \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "digest_frequency": "<string>",
  "digest_scope": "all",
  "digest_time": "<string>",
  "timezone": "<string>",
  "max_alerts_per_day": 123,
  "trigger_alerts_enabled": true,
  "inactivity_nudge_enabled": true,
  "weekly_review_enabled": true,
  "daily_digest_enabled": true,
  "weekly_review_scope": "all",
  "alert_scope": "all",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "quiet_hours_start": "<string>",
  "quiet_hours_end": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Response model for notification preferences.

​
id
string<uuid>
required
​
user_id
string<uuid>
required
​
digest_frequency
string
required
​
digest_scope
enum<string>
required
Available options:
all,
work,
personal
​
digest_time
string<time>
required
​
timezone
string
required
​
max_alerts_per_day
integer
required
​
trigger_alerts_enabled
boolean
required
​
inactivity_nudge_enabled
boolean
required
​
weekly_review_enabled
boolean
required
​
daily_digest_enabled
boolean
required
​
weekly_review_scope
enum<string>
required
Available options:
all,
work,
personal
​
alert_scope
enum<string>
required
Available options:
all,
work,
personal
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
quiet_hours_start
string<time> | null
​
quiet_hours_end
string<time> | null