User preferences can be fetched either in bulk or for individual components, depending on your UI implementation. All the API options are to fetch preference of a single user at a time.
- Get Overall Preferences: Most recommended method for preference UI preview if you are giving granular preference control to your users at both channel and category level. You can also use our pre-built preference component rather than building it in-house.
- Get Preferences for all categories: Returns preference of all categories and channels inside the category. Useful if you are just showing category opt-out option on UI.
- Get Preferences for all channels: Retrieves preferences for all active channels in a user's profile. Suitable if you are just showing channel opt-out option on UI.
- Get Preferences for a single category: Fetches preferences for a specific category and its channels. Typically used for debugging purposes and not ideal for UI since it requires calling individual APIs for all categories.