Messages
Get messages
Messages
Get messages
Returns a list of messages, could paginate using the page query parameter
GET
/
v1
/
messages
Authorization
Query
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
Authorizationheaderrequired
string
Query Parameters
channel
enum<string>
Available options:
in_app, email, sms, chat, push subscriberId
string
transactionId
string[]
page
Default: "0"number
limit
Default: "10"number
Response
200 - application/json
datarequired
object[]
hasMorerequired
boolean
pagerequired
number
pageSizerequired
number
Was this page helpful?
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
}