v4

OpenAPI 3.0.0MIT2026-07-311554531.6 MB

Subscribers

Retrieve subscriber notifications

This API is deprecated, use v2 API instead. Retrieve subscriber in-app notifications by its unique key identifier subscriberId.

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

Path parameters

subscriberIdstring required

Query parameters

pagenumber

limitnumber

readboolean

seenboolean

payloadstring

Base64 encoded string of the partial payload JSON object

Response

totalCountnumber

Total number of notifications available.

hasMoreboolean required

Indicates if there are more notifications to load.

pageSizenumber required

The number of notifications returned in this response.

pagenumber required

The current page number of the notifications.

Example response

{
  "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",
      "transactionId": "transaction_123456",
      "templateIdentifier": "template_abcdef",
      "providerId": "provider_xyz",
      "content": "This is a test notification content.",
      "subject": "Test Notification Subject",
      "seen": true,
      "deviceTokens": [
        "token1",
        "token2"
      ],
      "status": "sent",
      "payload": {
        "key": "value"
      },
      "data": {
        "key": "value"
      },
      "overrides": {
        "overrideKey": "overrideValue"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ],
  "pageSize": 2,
  "page": 1
}