GET
/
v1
/
subscribers
/
{subscriberId}
/
preferences
/
{parameter}
import { Novu } from "@novu/api";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.preferences.retrieveByLevel("<value>", "<value>");

  // Handle the result
  console.log(result)
}

run();
[
  {
    "template": {
      "_id": "<string>",
      "name": "<string>",
      "critical": true,
      "triggers": [
        "<string>"
      ]
    },
    "preference": {
      "enabled": true,
      "channels": {
        "email": true,
        "sms": true,
        "in_app": true,
        "chat": true,
        "push": true
      }
    }
  }
]

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

E.g ApiKey 18d2e625f05d80e

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
parameter
string
required
​
subscriberId
string
required

Response

200
application/json
Ok
​
preference
object
required

The preferences of the subscriber regarding the related workflow

​
template
object

The workflow information and if it is critical or not

Was this page helpful?