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();
{
  "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.