Get messages

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

E.g ApiKey 18d2e625f05d80e

Node.js

import { Novu, ChannelTypeEnum } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

const params = {
  page: 0, // optional
  limit: 20, // optional
  subscriberId: "subscriberId"  //optional
  channel: ChannelTypeEnum.EMAIL //optional
  transactionIds : ["txnId1","txnId2"] //optional
}

await novu.messages.list(params);

Response

{
    hasMore: true,
    data: [data],
    pageSize: 0,
    page: 0
}

Query Parameters

channel

enum<string>

Available options:

in_app,

email,

sms,

chat,

push

subscriberId

string

transactionId

string[]

page

number

default:0

limit

number

default:10

Response

200

application/json

hasMore

boolean

required

data

object[]

required

Show child attributes

data._environmentId

string

required

data._organizationId

string

required

data.transactionId

string

required

data._id

string

data.createdAt

string

data.channels

enum<string>

Available options:

in_app,

email,

sms,

chat,

push,

digest,

trigger,

delay

data.subscriber

object

Show child attributes

data.subscriber._id

string

required

data.subscriber.firstName

string

data.subscriber.lastName

string

data.subscriber.email

string

data.subscriber.phone

string

data.template

object

Show child attributes

data.template.name

string

required

data.template.triggers

object[]

required

Show child attributes

data.template.triggers.type

enum<string>

required

Available options:

event

data.template.triggers.identifier

string

required

data.template.triggers.variables

object[]

required

Show child attributes

data.template.triggers.variables.name

string

required

data.template.triggers.subscriberVariables

object[]

Show child attributes

data.template.triggers.subscriberVariables.name

string

required

data.template._id

string

data.jobs

object[]

Show child attributes

data.jobs._id

string

required

data.jobs.type

string

required

data.jobs.executionDetails

object[]

required

Show child attributes

data.jobs.executionDetails._id

string

required

data.jobs.executionDetails._jobId

string

required

data.jobs.executionDetails.status

enum<string>

required

Available options:

Success,

Warning,

Failed,

Pending,

Queued,

ReadConfirmation

data.jobs.executionDetails.detail

string

required

data.jobs.executionDetails.isRetry

boolean

required

data.jobs.executionDetails.isTest

boolean

required

data.jobs.executionDetails.providerId

object

required

data.jobs.executionDetails.source

enum<string>

required

Available options:

Credentials,

Internal,

Payload,

Webhook

data.jobs.executionDetails.raw

string

data.jobs.step

object

required

Show child attributes

data.jobs.step._id

string

required

data.jobs.step.active

boolean

required

data.jobs.step.filters

object

required

Show child attributes

data.jobs.step.filters.isNegated

boolean

required

data.jobs.step.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.jobs.step.filters.value

enum<string>

required

Available options:

AND,

OR

data.jobs.step.filters.children

object[]

required

Show child attributes

data.jobs.step.template

object

data.jobs.providerId

object

required

data.jobs.status

string

required

data.jobs.digest

object

data.jobs.payload

object

pageSize

number

required

page

number

required