List Notifications

Beta

GET/v1/messaging/notifications

This endpoint is idempotent. Learn more

Lists the notifications addressed to the current user, newest first.

The feed is personal and scoped to the account being acted in, so it never includes another user's notifications. Callers with no user membership in that account, such as an API key, get an empty list rather than an error.

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

Return only notifications of this category, such as chat.mention or order.updated.

statusoptional stringenumValues:unseenseenread

Return only notifications in this lifecycle state.

When omitted, the response is the active feed: every notification that has not been dismissed, whatever its seen or read state. Pass dismissed to review notifications that were cleared out of the feed.

sender_ids[]optional array

Return only notifications sent by these actors.

A notification sent by a person is attributed to their account user id, not their user id.

sender_types[]optional arrayenumValues:usergroupsystem

Return only notifications sent by these kinds of actor.

Notifications raised by the platform itself are attributed to the system sender type but are returned without a sender.

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.
customer.registered: a buyer completed registration on your customer portal.

titlestring

Short headline shown in the feed.

bodystringnullable

Supporting detail shown beneath the title, such as a preview of the message that triggered the notification.

statusstringenumValues:unseenseenread

Where the notification is in its lifecycle.

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

The status is derived from the seen, read, and dismissed timestamps, and only ever moves forward — a notification can never become unseen again.

prioritystringenumValues:lownormalhigh

How prominently the notification should be surfaced, from low through urgent.

senderactorExpandablenullable

The actor that generated this notification.

Notifications raised by the platform itself, rather than by a person, agent, or API key, 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

The role the actor holds in the account, which determines what it is permitted to do.

Always returned as null in this endpoint.

resourceentityExpandablenullable

The resource this notification is about, which the client can link to.

Chat notifications point at the conversation the message was posted in — or at the support case, for customer-facing threads — so opening the notification opens the thread.

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 was first surfaced to the user.

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 OpenMRP from '@openmrp/sdk';

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

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

console.log(listNotification.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  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=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibmZfeXZ3MmJmajJndXluIiwiZCI6ImYifQ.84E6zugdOsDIXsL5F9opO9OwUvwawpzXy4Cnd9DrvtI",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "nf_yvw2bfj2guyn",
      "object": "notification",
      "category": "order.updated",
      "title": "Order updated",
      "body": "Order #1024 changed from estimate to confirmed.",
      "status": "unseen",
      "priority": "normal",
      "sender": {
        "id": "acus_e5zu8bde0z3h",
        "object": "actor",
        "type": "user",
        "name": "Jie Yan",
        "handle": null,
        "avatar_url": null,
        "role": null
      },
      "resource": {
        "id": "or_9lqo07quiwyb",
        "object": "entity",
        "type": "sales_order",
        "name": "SO-001",
        "handle": 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=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibmZfeXZ3MmJmajJndXluIiwiZCI6ImYifQ.84E6zugdOsDIXsL5F9opO9OwUvwawpzXy4Cnd9DrvtI",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "nf_yvw2bfj2guyn",
      "object": "notification",
      "category": "order.updated",
      "title": "Order updated",
      "body": "Order #1024 changed from estimate to confirmed.",
      "status": "unseen",
      "priority": "normal",
      "sender": {
        "id": "acus_e5zu8bde0z3h",
        "object": "actor",
        "type": "user",
        "name": "Jie Yan",
        "handle": null,
        "avatar_url": null,
        "role": null
      },
      "resource": {
        "id": "or_9lqo07quiwyb",
        "object": "entity",
        "type": "sales_order",
        "name": "SO-001",
        "handle": 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