List Notification Preferences

Beta

GET/v1/messaging/preferences

This endpoint is idempotent. Learn more

Lists the caller's notification channel preferences (global default + per-category overrides).

Permissions requiredValues:messaging:read

The role behind your API key or agent must grant every one of these permissions.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of notification_preference

Resources in this page.

idstring

Preference ID.

objectstringenumValues:notification_preference

Resource type identifier.

categorystringnullable

The notification category this preference applies to.

null for the global default that applies to all categories without a specific preference.

in_app_enabledboolean

Whether in-app (bell) notifications are delivered for this category.

email_enabledboolean

Whether email notifications are delivered for this category.

push_enabledboolean

Whether push notifications are delivered for this category.

digeststringenumValues:instanthourlydaily

How email delivery for this category is batched.

instant: send an email as soon as an eligible notification occurs.
hourly: batch eligible notifications into a single hourly email.
daily: batch eligible notifications into a single daily email.
off: never send email for this category, even when email delivery is otherwise enabled.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for List Notification Preferences

List Notification Preferences

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listNotificationPreference = await client.messaging.preferences.list();

console.log(listNotificationPreference.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listNotificationPreference = await client.messaging.preferences.list();

console.log(listNotificationPreference.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/preferences?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibmZwZl8wMWg5ejhxMXcyZTNyNHQ1eTZ1N25mcGYiLCJkIjoiZiJ9.9KWGdKYjdSNrnVT0Bs_Kmm4s5Gm-P7uShysCJRB_Jjs",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "nfpf_01h9z8q1w2e3r4t5y6u7nfpf",
      "object": "notification_preference",
      "category": "chat.message",
      "in_app_enabled": true,
      "email_enabled": true,
      "push_enabled": false,
      "digest": "instant",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/preferences?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibmZwZl8wMWg5ejhxMXcyZTNyNHQ1eTZ1N25mcGYiLCJkIjoiZiJ9.9KWGdKYjdSNrnVT0Bs_Kmm4s5Gm-P7uShysCJRB_Jjs",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "nfpf_01h9z8q1w2e3r4t5y6u7nfpf",
      "object": "notification_preference",
      "category": "chat.message",
      "in_app_enabled": true,
      "email_enabled": true,
      "push_enabled": false,
      "digest": "instant",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Notification Preferences

Authorization

Returns

Responses