Get User Preferences
Full Preference
Fetches the current notification preferences for the user across all categories and channels.
GET
Authorizations
Pass as Bearer <API_KEY>
. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
distinct_id of the user whose preferences should be fetched
Query Parameters
to fetch user preferences for a particular tenant
set this flag to true
if you want to fetch channel list for opt-out categories.
Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.
You can apply single tag filter like tags=tag1
or build nested conditions using logical operators - and
, or
, not
, exists
.
Example:
tags=admin
tags={"or":[{"and":["admin","sales"]},{"and":["admin","manager"]}]}
tags={"not":"admin"}
tags={"exists":true}