Get Cross-Account Unread Summary

Beta

GET/v1/messaging/notifications/unread-summary

This endpoint is idempotent. Learn more

Returns the caller's unread totals across every account they belong to.

Permissions requiredValues:messaging:read

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

objectstringenumValues:notification_unread_summary

Resource type identifier.

totalinteger

Combined unread total across all of the caller's accounts.

accountslistnullable

Per-account unread tallies.

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_unread_summary_account

Resources in this page.

objectstringenumValues:notification_unread_summary_account

Resource type identifier.

accountentitynullable

The account this tally is for.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

unreadinteger

Number of unread items (notifications + announcements) in this account.

Responses

200

Successful response for Get Cross-Account Unread Summary

Get Cross-Account Unread Summary

import Augno from '@augno/sdk';

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

const notificationUnreadSummary = await client.messaging.notifications.retrieveUnreadSummary();

console.log(notificationUnreadSummary.accounts);

import Augno from '@augno/sdk';

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

const notificationUnreadSummary = await client.messaging.notifications.retrieveUnreadSummary();

console.log(notificationUnreadSummary.accounts);

200 example

{
  "object": "notification_unread_summary",
  "total": 5,
  "accounts": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "object": "notification_unread_summary_account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "entity",
          "type": "account",
          "name": null,
          "handle": null
        },
        "unread": 5
      }
    ]
  }
}

{
  "object": "notification_unread_summary",
  "total": 5,
  "accounts": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "object": "notification_unread_summary_account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "entity",
          "type": "account",
          "name": null,
          "handle": null
        },
        "unread": 5
      }
    ]
  }
}

Get Cross-Account Unread Summary

Authorization

Returns

Responses