GET
/
v1
/
messages
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);

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

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

E.g ApiKey 18d2e625f05d80e

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);

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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
channel
enum<string>

Channel type through which the message is sent

Available options:
in_app,
email,
sms,
chat,
push
​
subscriberId
string
​
transactionId
string[]
​
page
number
default:0
​
limit
number
default:10

Response

200
application/json

The response is of type object.