Get Consent Purpose List
Gets an array of ConsentPurpose objects.
NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
The identifiers of the ConsentPurpose object
Response
OK
Primary key
Name of consent purpose
Form text used for the actual checkbox
Text for the consent form, the long text to be shown when asking the end-user for this kind of consent
The key used to refer to this purpose, like #Process, #Emarketing etc.
List item tooltip
Is the consent purpose active or not
The date the consent purpose was last updated in UTC.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
true if the ConsentPurpose is deleted
Rank order
Name or description for the privacy statement
Url referencing the actual privacy statement
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
NSListAgentGet Consent PurposeGet Consent PurposesGet All Consent PurposeGet Consent Purpose Headings