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

# Get your notification settings

> Where you're reached, and what about. Email is off until you opt in.



## OpenAPI

````yaml get /api/notifications/settings
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/notifications/settings:
    get:
      tags:
        - Notifications
      summary: Get your notification settings
      description: Where you're reached, and what about. Email is off until you opt in.
      operationId: get_settings_api_notifications_settings_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettings'
        '403':
          description: Not a person's sign-in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    NotificationSettings:
      properties:
        email:
          $ref: '#/components/schemas/EmailSettings'
        timezone:
          type: string
          title: Timezone
          description: IANA time zone for digests and quiet hours.
        quiet_start:
          anyOf:
            - type: string
            - type: 'null'
          title: Quiet Start
          description: HH:MM, local.
        quiet_end:
          anyOf:
            - type: string
            - type: 'null'
          title: Quiet End
          description: HH:MM, local.
        channels:
          additionalProperties:
            $ref: '#/components/schemas/ChannelStatus'
          propertyNames:
            enum:
              - email
              - slack
              - teams
          type: object
          title: Channels
          description: What each channel looks like for the caller.
        topics:
          items:
            $ref: '#/components/schemas/TopicPreference'
          type: array
          title: Topics
          description: The settings grid.
      type: object
      required:
        - email
        - timezone
        - channels
        - topics
      title: NotificationSettings
      description: The caller's notification settings.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    EmailSettings:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Opted in. Off until the person turns it on.
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: 'Where it goes: the email on their Keycloak profile.'
        cadence:
          type: string
          enum:
            - immediate
            - hourly
            - daily
          title: Cadence
          description: Send each one, or gather them into an hourly or daily digest.
        digest_hour:
          type: integer
          maximum: 23
          minimum: 0
          title: Digest Hour
          description: Local hour the daily digest goes out.
      type: object
      required:
        - enabled
        - cadence
        - digest_hour
      title: EmailSettings
      description: The caller's email delivery.
    ChannelStatus:
      properties:
        available:
          type: boolean
          title: Available
          description: Whether the platform has the channel set up at all.
        connected:
          type: boolean
          title: Connected
          description: Whether the caller can be reached on it (signed in, or opted in).
        account_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Label
          description: 'Who the caller is there: an address, a workspace.'
        needs_reconnect:
          type: boolean
          title: Needs Reconnect
          description: The provider stopped accepting the connection.
          default: false
      type: object
      required:
        - available
        - connected
      title: ChannelStatus
      description: Whether a channel can be used here, and by the caller.
    TopicPreference:
      properties:
        key:
          type: string
          title: Key
          description: The topic's key.
        category:
          type: string
          enum:
            - reviews
            - runs
            - data
            - documents
            - security
          title: Category
          description: Its inbox category.
        label:
          type: string
          title: Label
          description: What the row says.
        hint:
          type: string
          title: Hint
          description: What it covers.
        channels:
          additionalProperties:
            type: boolean
          propertyNames:
            enum:
              - email
              - slack
              - teams
          type: object
          title: Channels
          description: Whether it goes out on each channel. In-app is always on.
      type: object
      required:
        - key
        - category
        - label
        - hint
        - channels
      title: TopicPreference
      description: 'One row of the settings grid: a topic and where it is sent.'
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.