NOnovu
Subscribers

Retrieve subscriber preferences

Changed on

Retrieve subscriber channel preferences by its unique key identifier subscriberId. This API returns all five channels preferences for all workflows and global preferences.

get/v2/subscribers/{subscriberId}/preferences

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Path parameters

subscriberIdstring required

The identifier of the subscriber

Query parameters

criticality'critical' | 'nonCritical' | 'all'
contextKeysstring[]

Context keys for filtering preferences (e.g., ["tenant:acme"])

[
  "tenant:acme"
]

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

Example response

{
  "global": {
    "channels": {
      "email": true,
      "in_app": true,
      "push": true,
      "tool": true
    },
    "schedule": {
      "isEnabled": true,
      "weeklySchedule": {
        "monday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "tuesday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "wednesday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "thursday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "friday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "saturday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "sunday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        }
      }
    }
  },
  "workflows": [
    {
      "channels": {
        "email": true,
        "in_app": true,
        "push": true,
        "tool": true
      }
    }
  ]
}

Changes

  • c69777f60184Revision changes
    • warning

      added the new tool enum value to the //// response property for the response status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////// to the response with the status