> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vanta.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml https://spec.speakeasy.com/vanta/vanta/conduct-an-audit-with-code-samples get /audits/{auditId}/organization/notifications
openapi: 3.0.0
info:
  title: Conduct an audit
  version: 1.0.0
  description: >-
    The Auditor API lets audit firms conduct audits from a tool outside of
    Vanta. Unlock data syncing with Vanta through this API.


    **Note for Vanta Gov (FedRAMP) customers:** Select `Vanta Gov (FedRAMP)`
    from the server dropdown to issue requests against
    `https://api.vanta-gov.com`. The OAuth token URL shown below defaults to the
    commercial host — replace it with `https://api.vanta-gov.com/oauth/token`.
  termsOfService: https://www.vanta.com/terms
  license:
    name: UNLICENSED
  contact:
    name: API Support
    url: https://help.vanta.com/
    email: support@vanta.com
servers:
  - url: https://api.vanta.com/v1
    description: US Region API
  - url: https://api.vanta-gov.com/v1
    description: Vanta Gov (FedRAMP)
security: []
paths:
  /audits/{auditId}/organization/notifications:
    get:
      tags:
        - Audits
      summary: Get organization notification settings for an audit
      description: |-
        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.
      operationId: GetOrganizationNotifications
      parameters:
        - description: The audit ID
          in: path
          name: auditId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Organization notifications record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditOrganizationNotifications'
              examples:
                Example 1:
                  value:
                    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
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: GetOrganizationNotifications
          source: |-
            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();
        - lang: java
          label: GetOrganizationNotifications
          source: >-
            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());
                    }
                }
            }
components:
  schemas:
    AuditOrganizationNotifications:
      description: |-
        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.
      properties:
        id:
          type: string
          description: Domain identifier of the audited organization.
          example: 5f2c939a52855e725c8d5824
        preferredTimeZone:
          type: string
          nullable: true
          description: >-
            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:
          type: string
          nullable: true
          description: >-
            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:
          items:
            type: string
          type: array
          description: |-
            Channels on which the personnel reminder digest is delivered (e.g.
            `["EMAIL"]` or `["EMAIL", "SLACK"]`).
          example:
            - EMAIL
        externalNotifications:
          items:
            $ref: '#/components/schemas/AuditOrganizationNotificationSubscription'
          type: array
          description: >-
            External notification subscriptions — one row per mailing-list
            address

            plus category pairing. Covers Compliance, Vendors, Access Reviews,
            and

            Trust Center categories.
      required:
        - id
      type: object
      additionalProperties: false
    AuditOrganizationNotificationSubscription:
      description: |-
        A single external-notification subscription row returned by the auditor
        organization notifications API. Represents one mailing-list address +
        notification-category pairing.
      properties:
        id:
          type: string
          description: Subscription record identifier.
          example: 65fa1b2c3d4e5f6789012345
        address:
          type: string
          description: Email address that receives notifications for this category.
          example: security-alerts@acme.example.com
        cadence:
          type: string
          nullable: true
          description: |-
            Cadence of summary notifications for this subscription, or null for
            non-summary (immediate / reminder) subscriptions.
          example: WEEKLY
        unsubSettingsKey:
          type: string
          description: |-
            Notification category the subscription belongs to (e.g.
            `SUMMARY_EMPLOYEE`, `NEW_VENDORS_DISCOVERED_EMAIL`,
            `TRUST_REPORT_ACCESS_REQUEST_EMAIL`).
          example: SUMMARY_EMPLOYEE
        toggleIsSubscribed:
          type: boolean
          description: >-
            Whether the address is currently subscribed to receive this
            category's

            notifications.
          example: true
      required:
        - id
        - address
        - cadence
        - unsubSettingsKey
        - toggleIsSubscribed
      type: object
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````