Get notification preferences

How the employee the token acts as wants to be notified — never anyone else’s, which is why there is no `employeeId` here. A missing preference row means every notification is on, so reading creates the row with the defaults rather than answering null.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

notifications:read

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/notification-preferences" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Notification preferences retrieved successfully!",
  "content": {
    "preference": {
      "employeeId": "emp_44f1",
      "emailDigestMode": "IMMEDIATE",
      "categoryPreferences": {
        "TIMEOFF": {
          "email": true,
          "sms": false
        }
      }
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Settings → Notifications

/settings/notifications