Skip to main content
GET
/
audits
/
{auditId}
/
organization
/
notifications
TypeScript
import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.getOrganizationNotifications({
    auditId: "<id>",
  });

  console.log(result);
}

run();
package hello.world;

import com.vanta.vanta_auditor_api.Vanta;
import com.vanta.vanta_auditor_api.models.operations.GetOrganizationNotificationsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Vanta sdk = Vanta.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetOrganizationNotificationsResponse res = sdk.audits().getOrganizationNotifications()
                .auditId("<id>")
                .call();

        if (res.auditOrganizationNotifications().isPresent()) {
            System.out.println(res.auditOrganizationNotifications().get());
        }
    }
}
curl --request GET \
  --url https://api.vanta.com/v1/audits/{auditId}/organization/notifications \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.vanta.com/v1/audits/{auditId}/organization/notifications"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vanta.com/v1/audits/{auditId}/organization/notifications', 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://api.vanta.com/v1/audits/{auditId}/organization/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.vanta.com/v1/audits/{auditId}/organization/notifications"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.vanta.com/v1/audits/{auditId}/organization/notifications")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "5f2c939a52855e725c8d5824",
  "preferredTimeZone": "America/New_York",
  "employeeDigestFrequency": "WEEKLY",
  "subscribedChannelTypes": [
    "EMAIL"
  ],
  "externalNotifications": [
    {
      "id": "65fa1b2c3d4e5f6789012345",
      "address": "hr-alerts@acme.example.com",
      "cadence": "WEEKLY",
      "unsubSettingsKey": "SUMMARY_EMPLOYEE",
      "toggleIsSubscribed": true
    },
    {
      "id": "65fa1b2c3d4e5f6789012346",
      "address": "security@acme.example.com",
      "cadence": null,
      "unsubSettingsKey": "TRUST_REPORT_ACCESS_REQUEST_EMAIL",
      "toggleIsSubscribed": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
auditId
string
required

The audit ID

Response

200 - application/json

Organization notifications record

Organization notifications record returned by the auditor API.

Ad-hoc single-row payload per domain mirroring the shape of the Organization → Notifications page. Only id is guaranteed; every other field is optional because controlled audit views can strip any column from the response.

​
id
string
required

Domain identifier of the audited organization.

Example:

"5f2c939a52855e725c8d5824"

​
preferredTimeZone
string | null

IANA timezone identifier that determines when scheduled reminder notifications are sent. null means the organization has no configured preference ("Anytime" in the UI).

Example:

"America/New_York"

​
employeeDigestFrequency
string | null

Frequency at which personnel reminder digests are sent (e.g. DAILY, WEEKLY, or NEVER). null when no notification settings have been configured for the organization.

Example:

"WEEKLY"

​
subscribedChannelTypes
string[]

Channels on which the personnel reminder digest is delivered (e.g. ["EMAIL"] or ["EMAIL", "SLACK"]).

Example:
["EMAIL"]
​
externalNotifications
object[]

External notification subscriptions — one row per mailing-list address plus category pairing. Covers Compliance, Vendors, Access Reviews, and Trust Center categories.