Get in-app notifications feed of subscriber.

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Response

{
  "data": [
    {
      "_environmentId": "string",
      "_feedId": "string",
      "_id": "string",
      "_messageTemplateId": "string",
      "_notificationId": "string",
      "_organizationId": "string",
      "_subscriberId": "string",
      "_templateId": "string",
      "channel": "in_app",
      "createdAt": "string",
      "cta": {
        "action": {
          "buttons": [
            {
              "content": "string",
              "resultContent": "string",
              "type": "primary"
            }
          ],
          "result": {
            "payload": "object",
            "type": "primary"
          },
          "status": "pending"
        },
        "data": {
          "url": "string"
        },
        "type": "redirect"
      },
      "deviceTokens": [
        "string"
      ],
      "directWebhookUrl": "string",
      "email": "string",
      "errorId": "string",
      "errorText": "string",
      "lastSeenDate": "string",
      "overrides": "object",
      "payload": "object",
      "phone": "string",
      "providerId": "string",
      "seen": "boolean",
      "status": "sent",
      "subject": "string",
      "subscriber": {
        "__v": "number",
        "_environmentId": "string",
        "_id": "string",
        "_organizationId": "string",
        "avatar": "string",
        "channels": [
          {
            "_integrationId": "string",
            "credentials": {
              "channel": "string",
              "deviceTokens": [
                "string"
              ],
              "webhookUrl": "string"
            },
            "integrationIdentifier": "string",
            "providerId": "slack"
          }
        ],
        "createdAt": "string",
        "deleted": "boolean",
        "email": "string",
        "firstName": "string",
        "isOnline": "boolean",
        "lastName": "string",
        "lastOnlineAt": "string",
        "locale": "string",
        "phone": "string",
        "subscriberId": "string",
        "updatedAt": "string"
      },
      "template": {
        "_creatorId": "string",
        "_environmentId": "string",
        "_id": "string",
        "_notificationGroupId": "string",
        "_organizationId": "string",
        "_parentId": "string",
        "active": "boolean",
        "critical": "boolean",
        "data": "object",
        "deleted": "boolean",
        "deletedAt": "string",
        "deletedBy": "string",
        "description": "string",
        "draft": "boolean",
        "name": "string",
        "notificationGroup": {
          "_environmentId": "string",
          "_id": "string",
          "_organizationId": "string",
          "_parentId": "string",
          "name": "string"
        },
        "preferenceSettings": {
          "chat": "boolean",
          "email": "boolean",
          "in_app": "boolean",
          "push": "boolean",
          "sms": "boolean"
        },
        "steps": [
          {
            "_id": "string",
            "_parentId": "object",
            "_templateId": "string",
            "active": "boolean",
            "filters": [
              {
                "children": [
                  {
                    "field": "string",
                    "operator": "LARGER",
                    "true": "subscriber",
                    "value": "string"
                  }
                ],
                "isNegated": "boolean",
                "type": "BOOLEAN",
                "value": "AND"
              }
            ],
            "name": "string",
            "replyCallback": "object",
            "shouldStopOnFail": "boolean",
            "template": "object",
            "uuid": "string"
          }
        ],
        "tags": [
          "string"
        ],
        "triggers": [
          {
            "identifier": "string",
            "subscriberVariables": [
              {
                "name": "string"
              }
            ],
            "type": "string",
            "variables": [
              {
                "name": "string"
              }
            ]
          }
        ],
        "workflowIntegrationStatus": "object"
      },
      "templateIdentifier": "string",
      "title": "string",
      "transactionId": "string"
    }
  ],
  "hasMore": "boolean",
  "page": "number",
  "pageSize": "number"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

subscriberId

string

required

Query Parameters

page

number

limit

number

default:10

Required range: x <= 100

read

boolean

seen

boolean

payload

string

Base64 encoded string of the partial payload JSON object

Response

200

application/json

page

number

required

The current page of the paginated response

hasMore

boolean

required

Does the list have more items to fetch

pageSize

number

required

Number of items on each page

data

object[]

required

The list of items matching the query

Show child attributes

data.name

string

required

data.identifier

string

required

data._environmentId

string

required

data._organizationId

string

required

data._id

string