GET
/
v1
/
notifications
Authorization
Query
curl --request GET \
  --url https://api.novu.co/v1/notifications \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "_environmentId": "string",
      "_id": "string",
      "_organizationId": "string",
      "channels": [
        "in_app"
      ],
      "createdAt": "string",
      "jobs": [
        {
          "_id": "string",
          "digest": "object",
          "executionDetails": [
            {
              "_id": "string",
              "_jobId": "string",
              "detail": "string",
              "isRetry": "boolean",
              "isTest": "boolean",
              "providerId": "object",
              "raw": "string",
              "source": "Credentials",
              "status": "Success"
            }
          ],
          "payload": "object",
          "providerId": "object",
          "status": "string",
          "step": {
            "_id": "string",
            "active": "boolean",
            "filters": {
              "children": [
                {
                  "field": "string",
                  "operator": "LARGER",
                  "true": "subscriber",
                  "value": "string"
                }
              ],
              "isNegated": "boolean",
              "type": "BOOLEAN",
              "value": "AND"
            },
            "template": "object"
          },
          "type": "string"
        }
      ],
      "subscriber": {
        "_id": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string"
      },
      "template": {
        "_id": "string",
        "name": "string",
        "triggers": [
          {
            "identifier": "string",
            "subscriberVariables": [
              {
                "name": "string"
              }
            ],
            "type": "string",
            "variables": [
              {
                "name": "string"
              }
            ]
          }
        ]
      },
      "transactionId": "string"
    }
  ],
  "hasMore": "boolean",
  "page": "number",
  "pageSize": "number"
}

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

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorizationheaderrequired
string

Query Parameters

channelsrequired
enum<string>[]
Available options:
in_app,
email,
sms,
chat,
push
templatesrequired
string[]
emailsrequired
string[]
searchrequired
string
subscriberIdsrequired
string[]
page
Default: "0"
number
transactionId
string

Response

200 - application/json
datarequired
object[]
hasMorerequired
boolean
pagerequired
number
pageSizerequired
number