Skip to main content
GET
/
v1
/
notifications
import co.novu.Novu
import co.novu.dto.request.NotificationRequest
import co.novu.extensions.notifications

fun main() {
    val novu = Novu(apiKey = "<NOVU_SECRET_KEY>")
    val notificationRequest = NotificationRequest("<CHANNELS>", "<TEMPLATES>", "<EMAILS>", "<SEARCH>");
    val notifications = novu.notifications(notificationRequest)
    println(notifications)
}

{
  "hasMore": true,
  "data": [
    {
      "_id": "<string>",
      "_environmentId": "<string>",
      "_organizationId": "<string>",
      "transactionId": "<string>",
      "createdAt": "<string>",
      "channels": "in_app",
      "subscriber": {
        "firstName": "<string>",
        "_id": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phone": "<string>"
      },
      "template": {
        "_id": "<string>",
        "name": "<string>",
        "triggers": [
          "<string>"
        ]
      },
      "jobs": [
        "<string>"
      ]
    }
  ],
  "pageSize": 123,
  "page": 123
}
Enter your API key in the Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80e
import co.novu.Novu
import co.novu.dto.request.NotificationRequest
import co.novu.extensions.notifications

fun main() {
    val novu = Novu(apiKey = "<NOVU_SECRET_KEY>")
    val notificationRequest = NotificationRequest("<CHANNELS>", "<TEMPLATES>", "<EMAILS>", "<SEARCH>");
    val notifications = novu.notifications(notificationRequest)
    println(notifications)
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
channels
enum<string>[]
​
templates
string[]
​
emails
string[]
​
search
string
deprecated
​
subscriberIds
string[]
​
page
number
default:0
​
transactionId
string
​
after
string
​
before
string

Response

​
hasMore
boolean
required
​
data
object[]
required

Array of Activity notifications

​
pageSize
number
required
​
page
number
required
⌘I