GET
/
v1
/
subscribers
/
{subscriberId}
/
preferences
import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SubscriberPreferenceResponse;

public class Main {
    public static void main(String[] args) {
        String apiKey = "<NOVU_API_KEY>";
        Novu novu = new Novu(apiKey);
        String subscriberId = "<SUBSCRIBER_ID>";

        SubscriberPreferenceResponse response = novu.getSubscriberPreferences(subscriberId);
    }
}

{
  "data": [
    {
      "preference": {
        "channels": {
          "chat": "boolean",
          "email": "boolean",
          "in_app": "boolean",
          "push": "boolean",
          "sms": "boolean"
        },
        "enabled": "boolean"
      },
      "template": {
        "_id": "string",
        "critical": "boolean",
        "name": "string"
      }
    }
  ]
}

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

E.g ApiKey 18d2e625f05d80e

import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SubscriberPreferenceResponse;

public class Main {
    public static void main(String[] args) {
        String apiKey = "<NOVU_API_KEY>";
        Novu novu = new Novu(apiKey);
        String subscriberId = "<SUBSCRIBER_ID>";

        SubscriberPreferenceResponse response = novu.getSubscriberPreferences(subscriberId);
    }
}

{
  "data": [
    {
      "preference": {
        "channels": {
          "chat": "boolean",
          "email": "boolean",
          "in_app": "boolean",
          "push": "boolean",
          "sms": "boolean"
        },
        "enabled": "boolean"
      },
      "template": {
        "_id": "string",
        "critical": "boolean",
        "name": "string"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
subscriberId
string
required

Response

200
application/json

Ok

The response is of type object[].