Sign in

v1

latestOpenAPI 3.0.1Vanta Terms of Service2026-07-26327517821.8 KB
Audits

Get organization notification settings for an audit

Retrieves organization notification settings for an audit.

This endpoint returns a single record containing the auditee organization's notification configuration — schedule, personnel reminder settings, and external notification subscriptions (Compliance, Vendors, Access Reviews, Trust Center).

The response is a single aggregate object per domain. Sorting and pagination are not applicable. Under a controlled audit view (TRIMMED_DOWN), only CAV-approved fields are included.

Rate limit: 10 requests / minute.

get/audits/{auditId}/organization/notifications

Path parameters

auditIdstring required

The audit ID

Response

Organization notifications record

idstring required

Domain identifier of the audited organization.

preferredTimeZonestring nullable

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

employeeDigestFrequencystring nullable

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.

subscribedChannelTypesstring[]

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

Example response

{
  "id": "5f2c939a52855e725c8d5824",
  "preferredTimeZone": "America/New_York",
  "employeeDigestFrequency": "WEEKLY",
  "subscribedChannelTypes": [
    "EMAIL"
  ],
  "externalNotifications": [
    {
      "id": "65fa1b2c3d4e5f6789012345",
      "address": "security-alerts@acme.example.com",
      "cadence": "WEEKLY",
      "unsubSettingsKey": "SUMMARY_EMPLOYEE",
      "toggleIsSubscribed": true
    }
  ]
}