---
title: "Your notification preferences"
method: GET
path: "/v1/notification-preferences"
tags: ["Notifications"]
---

# Your notification preferences

`GET /v1/notification-preferences`

## Request

- Base URL: `https://api.ironfang.com/security`
- URL: `https://api.ironfang.com/security/v1/notification-preferences`
- Auth: HTTP bearer

The caller's own choices for in-app and email notifications in this organisation. A channel with `custom: false` uses the recommended set: every change in-app; by email, critical and high issues and their return, a material severity increase, imminent certificate expiry, an important newly exposed service and monitoring stopping. Needs security.read only.

## Response `200`

The preferences.

- NotificationPreferences
  - `email` ChannelPreference, required
    - `certificate_alerts` boolean, required: Replaced certificates and expiry milestones.
    - `dns_changes` boolean, required: DNS and email records.
    - `enabled` boolean, required
    - `exposure_changes` boolean, required
    - `minimum_severity` 'critical' | 'high' | 'medium' | 'low' | 'info', required
    - `monitoring_failures` boolean, required: Scheduled checks that could not complete, and pauses.
    - `new_findings` boolean, required: New issues, returns and severity increases.
    - `resolved_findings` boolean, required: Resolved issues and improvements.
    - `custom` boolean, required: False while the recommended set applies.
  - `in_app` ChannelPreference, required
    - `certificate_alerts` boolean, required: Replaced certificates and expiry milestones.
    - `dns_changes` boolean, required: DNS and email records.
    - `enabled` boolean, required
    - `exposure_changes` boolean, required
    - `minimum_severity` 'critical' | 'high' | 'medium' | 'low' | 'info', required
    - `monitoring_failures` boolean, required: Scheduled checks that could not complete, and pauses.
    - `new_findings` boolean, required: New issues, returns and severity increases.
    - `resolved_findings` boolean, required: Resolved issues and improvements.
    - `custom` boolean, required: False while the recommended set applies.

## Other responses

- `default`: An error.

---

[API](https://skmtc.dev/ironfang/apis/ironfang-security-api.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-security-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-security-api/revisions/73bd66283d59?raw)
