Skip to content
WorkRoad home
REST API

Get notification settings

GET
/settings/notifications

Quiet hours, the email digest, push content, calendar alarms, and each notification kind's channels and timing.

Required scopes: settings:view

Authorization

headerAuthorizationBearer <token>

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://workroad.app/api/v1/settings/notifications' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "quietHoursEnabled": true,    "quietStart": "22:00",    "quietEnd": "07:00",    "pushShowContent": false,    "calendarAlarms": false,    "digestFrequency": "WEEKLY",    "digestTime": "07:30",    "digestWeekday": 1,    "emailSuppressedAt": null,    "emailSuppressedReason": null,    "emailVerified": true,    "kinds": [      {        "kind": "TASK_DUE",        "inApp": true,        "email": false,        "push": true,        "leadMinutes": 60,        "leadDays": [          1        ],        "localTime": "18:00"      },      {        "kind": "EXAM_SOON",        "inApp": true,        "email": true,        "push": true,        "leadMinutes": null,        "leadDays": [          3,          1        ],        "localTime": "18:00"      }    ]  }}

Get the dashboard layout GET

The dashboard cards shown, in order, and their sizes.

Get language, time zone and privacy GET

The app language, the account's time zone and leaderboard visibility.