Get in-app notification feed for a particular subscriber

GET/v1/subscribers/{subscriberId}/notifications/feed

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Path Parameters

subscriberIdRequiredstring

Query Parameters

pagenumber

limitnumber

Default: 10Maximum: 100

readboolean

seenboolean

payloadstring

Base64 encoded string of the partial payload JSON object

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X GET "https://api.novu.co/v1/subscribers/<string>/notifications/feed?page=0&limit=10&read=true&seen=true&payload=btoa%28JSON.stringify%28%7B+foo%3A+123+%7D%29%29+results+in+base64+encoded+string+like+eyJmb28iOjEyM30%3D" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>"

{
  "totalCount": 5,
  "hasMore": true,
  "data": [
    {
      "_id": "615c1f2f9b0c5b001f8e4e3b",
      "_templateId": "template_12345",
      "_environmentId": "env_67890",
      "_messageTemplateId": "message_template_54321",
      "_organizationId": "org_98765",
      "_notificationId": "notification_123456",
      "_subscriberId": "subscriber_112233",
      "_feedId": "feed_445566",
      "_jobId": "job_778899",
      "createdAt": "2024-12-10T10:10:59.639Z",
      "updatedAt": "2024-12-10T10:10:59.639Z",
      "actor": {
        "data": null,
        "type": "none"
      },
      "subscriber": {
        "_id": "string",
        "firstName": "string",
        "lastName": "string",
        "avatar": "string",
        "subscriberId": "string"
      },
      "transactionId": "transaction_123456",
      "templateIdentifier": "template_abcdef",
      "providerId": "provider_xyz",
      "content": "This is a test notification content.",
      "subject": "Test Notification Subject",
      "channel": "in_app",
      "read": false,
      "seen": true,
      "deleted": false,
      "deviceTokens": [
        "token1",
        "token2"
      ],
      "cta": {
        "type": "redirect",
        "data": {
          "url": "string"
        },
        "action": {
          "status": "pending",
          "buttons": [
            {
              "type": "primary",
              "content": "string",
              "resultContent": "string"
            }
          ],
          "result": {
            "payload": {},
            "type": "primary"
          }
        }
      },
      "status": "sent",
      "payload": {
        "key": "value"
      },
      "overrides": {
        "overrideKey": "overrideValue"
      }
    }
  ],
  "pageSize": 2,
  "page": 1
}

Get in-app notification feed for a particular subscriber

Authorization

Path Parameters

Query Parameters

Header Parameters

Response

TypeScript