List Notifications

Beta

GET/v1/messaging/notifications

This endpoint is idempotent. Learn more

Returns the current user's notifications, most recent first.

Permissions requiredValues:messaging:read

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

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

categoryoptional stringenumValues:chat.messagechat.mentionchat.added

Filter by category.

statusoptional stringenumValues:unseenseenread

Filter by lifecycle status.

When omitted, the feed returns the full active feed — every non-dismissed notification (seen and unseen alike), newest first.

sender_ids[]optional array

Filter by sender id(s).

sender_types[]optional arrayenumValues:usergroupsystem

Filter by sender type(s).

include[]optional arrayenumValues:senderresource

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

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

Resources in this page.

idstring

Notification ID.

objectstringenumValues:notification

Resource type identifier.

categorystringenumValues:chat.messagechat.mentionchat.added

The kind of event this notification represents.

The set is open-ended and may grow over time. Common first-party categories are:

chat.message: a new message in a conversation.
chat.mention: a direct @mention, delivered even when the conversation is muted.
chat.added: the user was added to a conversation.
order.updated: an order the user is involved with changed.
agent.run_completed: an agent run the user triggered finished.
agent.alert: an agent raised an alert during a run.
system.broadcast: a targeted system message.

titlestring

Human-readable title.

bodystringnullable

Preview/body text.

statusstringenumValues:unseenseenread

Where the notification is in its lifecycle.

unseen: not yet surfaced in the notification dropdown.
seen: surfaced in the dropdown but not yet opened.
read: explicitly opened by the user.
dismissed: removed from the active feed.

prioritystringenumValues:lownormalhigh

Delivery priority.

senderactorExpandablenullable

The actor that generated this notification — a user, group, agent, or API key.

System-generated notifications have no sender.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

Always returned as null in this endpoint.

resourceentityExpandablenullable

The app resource this notification links to, if any.

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).

seen_atstring (date-time)nullable

When the notification first appeared in the dropdown.

read_atstring (date-time)nullable

When the notification was explicitly opened.

dismissed_atstring (date-time)nullable

When the notification was dismissed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for List Notifications

List Notifications

import Augno from '@augno/sdk';

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

const listNotification = await client.messaging.notifications.list();

console.log(listNotification.data);

import Augno from '@augno/sdk';

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

const listNotification = await client.messaging.notifications.list();

console.log(listNotification.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/notifications?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibmZfMDFoOXo4cTF3MmUzcjR0NXk2dTdpOG85IiwiZCI6ImYifQ.PwRk_vVxh9mRiN-BdaMEl-YMetT9kvwLmLFionL7oV0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "nf_01h9z8q1w2e3r4t5y6u7i8o9",
      "object": "notification",
      "category": "order.updated",
      "title": "Order updated",
      "body": "Order #1024 changed from estimate to confirmed.",
      "status": "unseen",
      "priority": "normal",
      "sender": {
        "id": "acus_01ea9983ddb41dacc44ecf997c",
        "object": "actor",
        "type": "user",
        "name": "Jie Yan",
        "handle": null,
        "avatar_url": null,
        "role": null
      },
      "resource": null,
      "seen_at": null,
      "read_at": null,
      "dismissed_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/messaging/notifications?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibmZfMDFoOXo4cTF3MmUzcjR0NXk2dTdpOG85IiwiZCI6ImYifQ.PwRk_vVxh9mRiN-BdaMEl-YMetT9kvwLmLFionL7oV0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "nf_01h9z8q1w2e3r4t5y6u7i8o9",
      "object": "notification",
      "category": "order.updated",
      "title": "Order updated",
      "body": "Order #1024 changed from estimate to confirmed.",
      "status": "unseen",
      "priority": "normal",
      "sender": {
        "id": "acus_01ea9983ddb41dacc44ecf997c",
        "object": "actor",
        "type": "user",
        "name": "Jie Yan",
        "handle": null,
        "avatar_url": null,
        "role": null
      },
      "resource": null,
      "seen_at": null,
      "read_at": null,
      "dismissed_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Notifications

Authorization

Query Parameters

Returns

Responses