Skip to main content
GET
/
notifications
/
preferences
List Notification Preferences
curl --request GET \
  --url https://www.corgea.app/api/v1/notifications/preferences \
  --header 'CORGEA-TOKEN: <api-key>'
{
  "status": "ok",
  "preferences": [
    {
      "type": {
        "code": "scheduled_scan.daily_report",
        "name": "Daily Scheduled Scan Report",
        "description": "Summary email sent once per day with new issues discovered by scheduled scans.",
        "category": "scheduled_scans",
        "default_email_enabled": true,
        "default_webhook_enabled": true
      },
      "email_enabled": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.corgea.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

CORGEA-TOKEN
string
header
required

API key for authentication

Response

Notification preferences retrieved successfully

status
string
Example:

"ok"

preferences
object[]