Skip to main content
GET
/
notifications
List notifications
curl --request GET \
  --url https://api.salesive.com/api/v1/notifications \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Notifications retrieved",
  "data": {
    "notifications": [
      {
        "title": "Today",
        "data": [
          {
            "_id": "66b3f0a1c2d4e5f600112233",
            "user": "66a1b2c3d4e5f60011223344",
            "shop": "66a0a1b2c3d4e5f600112200",
            "title": "New order received",
            "message": "Order #1042 was just placed for $59.99.",
            "type": "order",
            "read": false,
            "data": {
              "orderId": "66b3efaa11223344556677"
            },
            "createdAt": "2026-06-28T09:14:00.000Z",
            "updatedAt": "2026-06-28T09:14:00.000Z"
          }
        ]
      },
      {
        "title": "Yesterday",
        "data": [
          {
            "_id": "66b2cd33aabbccdd00112233",
            "user": "66a1b2c3d4e5f60011223344",
            "shop": "66a0a1b2c3d4e5f600112200",
            "title": "Low stock",
            "message": "Blue Hoodie is down to 3 units.",
            "type": "info",
            "read": true,
            "readAt": "2026-06-27T18:02:00.000Z",
            "data": {},
            "createdAt": "2026-06-27T15:40:00.000Z",
            "updatedAt": "2026-06-27T18:02:00.000Z"
          }
        ]
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "pages": 1
    },
    "unreadCount": 1
  }
}
Returns the merchant’s notifications grouped into date-labelled sections (“Today”, “Yesterday”, or a full weekday date), along with the total unread count. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

​
page
integer
default:1

Page number to retrieve.

Required range: x >= 1
​
limit
integer
default:10

Number of notifications per page.

Required range: x >= 1

Response

Paginated, date-grouped notifications plus the unread count.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object