Subscribers

Retrieve subscriber preferences

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

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"])

Headers

idempotency-keystring

A header for idempotency purposes

Response

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

Changed in 1 of the 12 revisions of this API.12

Jul 21, 2026c69777f6018412See the full diff
- ●
  added the new tool enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added

Full history