Get in-app notifications feed of subscriber.

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

E.g ApiKey 18d2e625f05d80e

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

data

object

Show child attributes

data.data

object[]

required

Array of notifications returned in the response.

Show child attributes

data.data._environmentId

string

required

Identifier for the environment where the notification is sent.

data.data._feedId

string

required

Identifier for the feed associated with the notification.

data.data._id

string

required

Unique identifier for the notification.

data.data._jobId

string

required

Identifier for the job that triggered the notification.

data.data._messageTemplateId

string

required

Identifier for the message template used.

data.data._notificationId

string

required

Unique identifier for the notification instance.

data.data._organizationId

string

required

Identifier for the organization sending the notification.

data.data._subscriberId

string

required

Unique identifier for the subscriber receiving the notification.

data.data._templateId

string

required

Identifier for the template used to generate the notification.

data.data.channel

enum<string>

required

The channel through which the notification is sent.

Available options:

in_app,

email,

sms,

chat,

push

data.data.content

string

required

The main content of the notification.

data.data.cta

object

required

Call-to-action information associated with the notification.

Show child attributes

data.data.cta.data

object

required

Show child attributes

data.data.cta.data.url

string

data.data.cta.action

object

Show child attributes

data.data.cta.action.buttons

object[]

Show child attributes

data.data.cta.action.result

object

Show child attributes

data.data.cta.action.status

enum<string>

Available options:

pending,

done

data.data.cta.type

enum<string>

Available options:

redirect

data.data.deleted

boolean

required

Indicates whether the notification has been deleted.

data.data.read

boolean

required

Indicates whether the notification has been read by the subscriber.

data.data.seen

boolean

required

Indicates whether the notification has been seen by the subscriber.

data.data.status

enum<string>

required

Current status of the notification.

Available options:

sent,

error,

warning

data.data.transactionId

string

required

Unique identifier for the transaction associated with the notification.

data.data.actor

object

Actor details related to the notification, if applicable.

Show child attributes

data.data.actor.data

string | null

required

The data associated with the actor, can be null if not applicable.

data.data.actor.type

enum<string>

required

The type of the actor, indicating the role in the notification process.

Available options:

none,

user,

system_icon,

system_custom

data.data.createdAt

string | null

Timestamp indicating when the notification was created.

data.data.deviceTokens

string[] | null

Device tokens for push notifications, if applicable.

data.data.overrides

object

Provider-specific overrides used when triggering the notification.

data.data.payload

object

The payload that was used to send the notification trigger.

data.data.providerId

string | null

Identifier for the provider that sends the notification.

data.data.subject

string | null

The subject line for email notifications, if applicable.

data.data.subscriber

object

Subscriber details associated with this notification.

Show child attributes

data.data.subscriber.subscriberId

string

required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

data.data.subscriber._id

string

The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId used in your queries. Refer to subscriberId for that identifier.

data.data.subscriber.avatar

string

The URL of the subscriber's avatar image.

data.data.subscriber.firstName

string

The first name of the subscriber.

data.data.subscriber.lastName

string

The last name of the subscriber.

data.data.templateIdentifier

string | null

Identifier for the template used, if applicable.

data.data.updatedAt

string | null

Timestamp indicating when the notification was last updated.

data.hasMore

boolean

required

Indicates if there are more notifications to load.

data.page

number

required

The current page number of the notifications.

data.pageSize

number

required

The number of notifications returned in this response.

data.totalCount

number

Total number of notifications available.