Didomi icon

Didomi

Use the Didomi API

Actions75

Data Manager → List Preferences

AI-generated

Overview

This node operation lists preferences managed in the Didomi platform's Data Manager resource. It allows users to retrieve a collection of preference records with optional query parameters to filter and control the results, such as limiting the number of results, filtering by organization user ID, status, regulation, and other criteria. This operation is useful for managing and auditing user preferences related to data privacy and consent within an organization.

Use Case Examples

  1. A privacy officer wants to retrieve all user preferences related to a specific regulation to ensure compliance.
  2. A data manager needs to list preferences with a limit of 100 to review recent changes.
  3. An analyst filters preferences by organization user ID to generate a report on user consent trends.

Properties

Name Meaning
Query Parameters Collection of optional filters and controls to refine the list of preferences returned by the API, including pagination, filtering by IDs, status, counts, and other attributes.

Output

JSON

  • json - The JSON array of preference objects returned by the Didomi API, representing the list of preferences matching the query parameters.

Dependencies

  • Didomi API credentials (API Key and API Secret) are required for authentication.

Troubleshooting

  • Missing or invalid API Key or API Secret will cause authentication failure and prevent the node from executing.
  • Required parameters such as Configuration Tree ID or Preference ID (if applicable) must be provided; otherwise, the node throws an error indicating the missing parameter.
  • API request failures or network issues will result in error messages from the Didomi API, which are propagated by the node with details for troubleshooting.

Discussion