List Notification Preferences

curl --request GET \
  --url https://www.corgea.app/api/v1/notifications/preferences \
  --header 'CORGEA-TOKEN: <api-key>'

const options = {method: 'GET', headers: {'CORGEA-TOKEN': '<api-key>'}};

fetch('https://www.corgea.app/api/v1/notifications/preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.corgea.app/api/v1/notifications/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "CORGEA-TOKEN: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.corgea.app/api/v1/notifications/preferences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("CORGEA-TOKEN", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.corgea.app/api/v1/notifications/preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["CORGEA-TOKEN"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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",
        "audience": "company_admins",
        "default_email_enabled": true,
        "default_webhook_enabled": true
      },
      "email_enabled": true,
      "source": "user"
    }
  ]
}

{
  "error": "Missing or invalid authorization header"
}

GET

notifications

preferences

List Notification Preferences

curl --request GET \
  --url https://www.corgea.app/api/v1/notifications/preferences \
  --header 'CORGEA-TOKEN: <api-key>'

const options = {method: 'GET', headers: {'CORGEA-TOKEN': '<api-key>'}};

fetch('https://www.corgea.app/api/v1/notifications/preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.corgea.app/api/v1/notifications/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "CORGEA-TOKEN: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.corgea.app/api/v1/notifications/preferences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("CORGEA-TOKEN", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.corgea.app/api/v1/notifications/preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["CORGEA-TOKEN"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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",
        "audience": "company_admins",
        "default_email_enabled": true,
        "default_webhook_enabled": true
      },
      "email_enabled": true,
      "source": "user"
    }
  ]
}

{
  "error": "Missing or invalid authorization header"
}

Authorizations

CORGEA-TOKEN

string

header

required

API key for authentication API tokens belonging to inactive users are rejected.

Response

Notification preferences retrieved successfully

status

string

Example:

"ok"

preferences

object[]

Show child attributes

API Reference

Authentication

Scans

Issues

Triage

Dependencies

Starting Corgea Scan

Uploading 3rd Party Scan

Skills

Projects

Policies

Notifications

Teams

Harness integrations

Users

List Notification Preferences

Authorizations

Response