List Preferences

List the configured preferences for the given user.

GET /notifications/v1/preferences

List Preferences

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences \
  --header 'apikey: <api-key>'

200

{
  "data": {
    "preferences": {
      "group": {
        "messagesSetting": 2,
        "messagesOverride": true,
        "repliesSetting": 2,
        "repliesOverride": true,
        "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
      },
      "oneOnOne": {
        "messagesSetting": 2,
        "messagesOverride": true,
        "repliesSetting": 2,
        "repliesOverride": true,
        "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
      }
    },
    "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 {{message.type}}",
        "body_file": "Has sent a {{message.type}}",
        "body_image": "Has sent an {{message.type}}",
        "body_video": "Has sent a {{message.type}}"
      },
      "mediaMessageTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body_audio": "New message",
        "body_file": "New message",
        "body_image": "New message",
        "body_video": "New 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": "{{message.data.text}}",
        "body_fallback": "New message"
      }
    }
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Query Parameters

uid · string · required

(Required) UID

Response

200 - application/json

A list of push notification's settings

data · object[]

Show child attributes

meta · object