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

> List preferences, templates and sounds for the given app.

# List Settings

For the complete error reference, see [Error Guide](/rest-api/notifications-apis/error-codes).


## OpenAPI

````yaml get /notifications/v1/settings
openapi: 3.0.0
info:
  title: Chat APIs
  description: Manage messages, users, groups for a particular app using our Chat API.
  version: '3.0'
servers:
  - url: https://{appId}.api-{region}.cometchat.io/v3
    variables:
      appId:
        default: appId
        description: (Required) App ID
      region:
        enum:
          - us
          - eu
          - in
        default: us
        description: Select Region
security: []
tags:
  - name: API Keys
    description: The API keys are used to authorise the APIs
  - name: Roles
    description: The roles are used to give user access rights
  - name: Users
    description: The REST collection for users.
  - name: Auth Tokens
    description: The auth tokens are used to login end users using client SDKs.
  - name: Blocked Users
    description: The REST collections for blocked users.
  - name: Friends
    description: List,add and remove friends by passing UID in path variables
  - name: Groups
    description: The REST collections for groups.
  - name: Banned Users
    description: Ban and Unban user by passing other UID in path variables.
  - name: Group Members
    description: The REST collections for group members.
  - name: Messages
    description: The REST collections for messages.
  - name: Conversations
    description: The REST collections for conversations.
  - name: Restrict Features
    description: Allows Restricting Features
  - name: Metrics
    description: Allows accessing Data Metrics
  - name: Triggers
    description: Allows adding triggers to a webhook.
  - name: Webhooks
    description: Allows accessing Webhooks.
  - name: Notifications
    description: Allows configuring Notifications core.
paths:
  /notifications/v1/settings:
    get:
      tags:
        - Notifications
      summary: List Settings
      description: List preferences, templates and sounds for the given app.
      operationId: notifications-push-list-settings
      responses:
        '200':
          description: A list of push notification's settings
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        group:
                          type: object
                        bypassPreferencesForMentions:
                          type: boolean
                        call:
                          type: object
                        oneOnOne:
                          type: object
                        mute:
                          type: object
                        email:
                          type: object
                        sms:
                          type: object
                        push:
                          type: object
                  meta:
                    type: object
                type: object
              example:
                data:
                  preferences:
                    group:
                      messagesSetting: 2
                      messageEditedSetting: 2
                      messagesOverride: true
                      repliesSetting: 2
                      repliesOverride: true
                      messageDeletedSetting: 2
                      reactionsSetting: 2
                      reactionsOverride: true
                      memberLeftSetting: 1
                      memberLeftOverride: true
                      memberAddedSetting: 1
                      memberAddedOverride: true
                      memberJoinedSetting: 1
                      memberJoinedOverride: true
                      memberKickedSetting: 1
                      memberKickedOverride: true
                      memberBannedSetting: 1
                      memberBannedOverride: true
                      memberUnbannedSetting: 1
                      memberUnbannedOverride: true
                      memberScopeChangedSetting: 1
                      memberScopeChangedOverride: true
                    bypassPreferencesForMentions: false
                    call:
                      busySetting: 1
                      cancelledSetting: 1
                      endedSetting: 1
                      initiatedSetting: 1
                      ongoingSetting: 1
                      rejectedSetting: 1
                      unansweredSetting: 1
                      initiatedOverride: false
                      ongoingOverride: false
                      cancelledOverride: false
                      rejectedOverride: false
                      unansweredOverride: false
                      busyOverride: false
                      endedOverride: false
                    oneOnOne:
                      messagesSetting: 2
                      messagesOverride: true
                      repliesSetting: 2
                      repliesOverride: true
                      messageEditedSetting: 2
                      messageDeletedSetting: 2
                      reactionsSetting: 2
                      reactionsOverride: true
                    mute:
                      dndPreferenceSetting: 1
                      dndPreferenceOverride: true
                      schedulePreferenceSetting:
                        monday:
                          from: 0
                          to: 2359
                          dnd: false
                        tuesday:
                          from: 0
                          to: 2359
                          dnd: false
                        wednesday:
                          from: 0
                          to: 2359
                          dnd: false
                        thursday:
                          from: 0
                          to: 2359
                          dnd: false
                        friday:
                          from: 0
                          to: 2359
                          dnd: false
                        saturday:
                          from: 0
                          to: 2359
                          dnd: false
                        sunday:
                          from: 0
                          to: 2359
                          dnd: false
                      schedulePreferenceOverride: true
                      mutedGroupsOverride: true
                      mutedOneOnOnesOverride: true
                    email:
                      notifyForUnreadOnly: true
                      intervalInSeconds: 7200
                      maxPerDay: 20
                      maxPerDayPerConversation: 2
                    sms:
                      notifyForUnreadOnly: true
                      intervalInSeconds: 7200
                      maxPerDay: 20
                      maxPerDayPerConversation: 2
                    push:
                      includeMessageObjectSetting: false
                      includeSenderMetadataSetting: true
                      includeReceiverMetadataSetting: true
                      trimTextFieldSetting: false
                      includeMessageMetadataSetting: true
                      customJson:
                        hello: world
                  sound:
                    chat: default
                    call: default
                  templates:
                    usePrivacyTemplate: 3
                    textMessageTemplateDefault:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: '{{message.data.text}}'
                    textMessageTemplatePrivacy:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: New message
                    mediaMessageTemplateDefault:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body_audio: 🔈 Has sent an audio
                      body_file: 📄 Has sent a file
                      body_image: 📷 Has sent an image
                      body_video: 🎥 Has sent a video
                    mediaMessageTemplatePrivacy:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body_audio: New audio message
                      body_file: New file message
                      body_image: New image message
                      body_video: New video message
                    pollMessageTemplateDefault:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: '{{message.data.text}}'
                      body_fallback: ''
                    pollMessageTemplatePrivacy:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: '{{message.data.text}}'
                      body_fallback: ''
                    reminderMessageTemplateDefault:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: '{{message.data.text}}'
                      body_fallback: ''
                    reminderMessageTemplatePrivacy:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: '{{message.data.text}}'
                      body_fallback: ''
                    customMessageTemplateDefault:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: '{{message.data.text}}'
                      body_fallback: New message
                    customMessageTemplatePrivacy:
                      titleOneOnOne: '{{message.data.entities.sender.entity.name}}'
                      titleGroup: >-
                        {{message.data.entities.sender.entity.name}} @
                        {{message.data.entities.receiver.entity.name}}
                      body: New message
                      body_fallback: New message
                    emailSubjectTemplateDefault:
                      subjectGroup: New messages in {{groupDetails.name}}
                      subjectOneOnOne: New messages from {{senderDetails.name}}
                    emailSubjectTemplatePrivacy:
                      subjectGroup: New messages in {{groupDetails.name}}
                      subjectOneOnOne: New messages from {{senderDetails.name}}
                    smsContentTemplateDefault:
                      bodyGroup: >-
                        You've received {{messages.length}} message(s) in
                        {{groupDetails.name}}! Read them at
                        https://your-website.com.
                      bodyOneOnOne: >-
                        You've received {{messages.length}} message(s) from
                        {{senderDetails.name}}! Read them at
                        https://your-website.com.
                    smsContentTemplatePrivacy:
                      bodyGroup: >-
                        You've received {{messages.length}} message(s) in
                        {{groupDetails.name}}! Read them at
                        https://your-website.com.
                      bodyOneOnOne: >-
                        You've received {{messages.length}} message(s) from
                        {{senderDetails.name}}! Read them at
                        https://your-website.com.
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      description: API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
      name: apikey
      in: header

````