Get notifications

GET/v1/notifications

Authorization

Authorization<token>

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

In: header

Query Parameters

channelsarray<string>

Array of channel types

templatesarray<string>

Array of template IDs or a single template ID

emailsarray<string>

Array of email addresses or a single email address

searchDeprecatedstring

Search term (deprecated)

subscriberIdsarray<string>

Array of subscriber IDs or a single subscriber ID

severityarray<string>

Array of severity levels or a single severity level

pagenumber

Page number for pagination

Default: 0Minimum: 0

limitnumber

Limit for pagination

Default: 10Minimum: 1Maximum: 50

transactionIdstring

The transaction ID to filter by

topicKeystring

Topic Key for filtering notifications by topic

contextKeysarray<string>

Filter by exact context keys (format: "type:id")

afterstring

Date filter for records after this timestamp. Defaults to earliest date allowed by subscription plan

beforestring

Date filter for records before this timestamp. Defaults to current time of request (now)

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X GET "https://api.novu.co/v1/notifications?channels=in_app&templates=string&emails=string&search=%3Cstring%3E&subscriberIds=string&severity=string&page=0&limit=10&transactionId=%3Cstring%3E&topicKey=%3Cstring%3E&contextKeys=string&after=%3Cstring%3E&before=%3Cstring%3E" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>"

{
  "hasMore": true,
  "data": [
    {
      "_id": "string",
      "_environmentId": "string",
      "_organizationId": "string",
      "_subscriberId": "string",
      "transactionId": "string",
      "_templateId": "string",
      "_digestedNotificationId": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "channels": [
        "in_app"
      ],
      "subscriber": {
        "firstName": "string",
        "subscriberId": "string",
        "_id": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string"
      },
      "template": {
        "_id": "string",
        "name": "string",
        "origin": "novu-cloud",
        "triggers": [
          {
            "type": "event",
            "identifier": "string",
            "variables": [
              {
                "name": "string"
              }
            ],
            "subscriberVariables": [
              {
                "name": "string"
              }
            ]
          }
        ]
      },
      "jobs": [
        {
          "_id": "string",
          "type": "in_app",
          "digest": {
            "digestKey": "string",
            "amount": 0,
            "unit": "seconds",
            "type": "regular",
            "events": [
              {}
            ],
            "backoff": true,
            "backoffAmount": 0,
            "backoffUnit": "seconds",
            "updateMode": true,
            "timed": {
              "atTime": "string",
              "weekDays": [
                "monday"
              ],
              "monthDays": [
                0
              ],
              "ordinal": "1",
              "ordinalValue": "day",
              "monthlyType": "each",
              "cronExpression": "string",
              "untilDate": "string"
            }
          },
          "executionDetails": [
            {
              "_id": "string",
              "createdAt": "string",
              "status": "Success",
              "detail": "string",
              "isRetry": true,
              "isTest": true,
              "providerId": "emailjs",
              "raw": "string",
              "source": "Credentials"
            }
          ],
          "step": {
            "_id": "string",
            "active": true,
            "replyCallback": {},
            "controlVariables": {},
            "metadata": {},
            "issues": {},
            "filters": [
              {
                "isNegated": true,
                "type": "BOOLEAN",
                "value": "AND",
                "children": [
                  {
                    "field": "string",
                    "value": "string",
                    "operator": "LARGER",
                    "on": "subscriber"
                  }
                ]
              }
            ],
            "template": {},
            "variants": [
              {
                "_id": "string",
                "active": true,
                "replyCallback": {},
                "controlVariables": {},
                "metadata": {},
                "issues": {},
                "filters": [
                  {
                    "isNegated": true,
                    "type": "BOOLEAN",
                    "value": "AND",
                    "children": [
                      {
                        "field": "string",
                        "value": "string",
                        "operator": "LARGER",
                        "on": "subscriber"
                      }
                    ]
                  }
                ],
                "template": {},
                "variants": [],
                "_templateId": "string",
                "name": "string",
                "_parentId": "string"
              }
            ],
            "_templateId": "string",
            "name": "string",
            "_parentId": "string"
          },
          "overrides": {
            "workflowId": "some_wf_id",
            "stepId": "some_wf_id"
          },
          "payload": {},
          "providerId": "emailjs",
          "status": "string",
          "updatedAt": "string",
          "scheduleExtensionsCount": 0
        }
      ],
      "payload": {},
      "tags": [
        "string"
      ],
      "controls": {},
      "to": {},
      "topics": [
        {
          "_topicId": "string",
          "topicKey": "string"
        }
      ],
      "severity": "high",
      "critical": true,
      "contextKeys": [
        "string"
      ]
    }
  ],
  "pageSize": 0,
  "page": 0
}

Authorization

Query Parameters

Header Parameters

Response

TypeScript