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

# Get notification preferences

> Returns the authenticated user notification toggles for AI responses, automations, escalations, calls, campaigns, and other events.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/user/notification-preferences
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/user/notification-preferences:
    get:
      tags:
        - Users
      summary: Get notification preferences
      description: >-
        Returns the authenticated user notification toggles for AI responses,
        automations, escalations, calls, campaigns, and other events.
      operationId: get_user_notification_preferences
      responses:
        '200':
          description: Notification preferences returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserNotificationPreferencesResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
        '500':
          description: Failed to fetch notification preferences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    UserNotificationPreferencesResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/UserNotificationPreferences'
      required:
        - success
        - data
      additionalProperties: true
      example:
        success: true
        data:
          aiResponses: true
          escalations: true
          assignments: true
          calls: false
          campaigns: true
    UserErrorResponse:
      type: object
      description: >-
        Generic error envelope returned by Users endpoints. Most paths only
        include `error`; some add `details` for diagnostic context.
      properties:
        error:
          type: string
        details:
          type: string
      required:
        - error
      additionalProperties: true
      example:
        error: User not found
        details: No user with id 64ee9a8b1e7f2a0011223399
    UserNotificationPreferences:
      type: object
      properties:
        aiResponses:
          type: boolean
        inboundInAutopilot:
          type: boolean
        automationTriggers:
          type: boolean
        emailSync:
          type: boolean
        escalations:
          type: boolean
        autopilotMonitor:
          type: boolean
        humanMonitor:
          type: boolean
        assignments:
          type: boolean
        calls:
          type: boolean
        campaigns:
          type: boolean
        other:
          type: boolean
      additionalProperties: true
      example:
        aiResponses: true
        inboundInAutopilot: true
        automationTriggers: false
        emailSync: true
        escalations: true
        autopilotMonitor: false
        humanMonitor: true
        assignments: true
        calls: false
        campaigns: true
        other: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````