v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

Topics

Get topics

Returns a list of preference center topics, optionally filtered by brand group and visibility. For SMART campaign topics, set hideFromUi=true to get topics that are hidden from the preference center UI (and thus used for SMART campaigns). If hideFromUi is not provided, only customer-visible topics are returned.

get/preference-center/api/v1/topics

Query parameters

brandGroupIdstring uuid

Filters result set by brand group id

hideFromUiboolean

When true, returns only SMART campaign topics (hidden from UI). When false or omitted, returns only customer-visible topics.

Response

Success. Returns list of topics.

idstring uuid

Unique identifier of the topic (set by server on create)

namestring

Display name of the topic

descriptionstring

Description of the topic

parentIdstring uuid nullable

Parent topic ID for hierarchical topics

orderinteger

Display order in the preference center

brandGroupIdstring uuid

Brand group this topic belongs to

createdAtstring date-time nullable

Set by server

createdBystring nullable

Set by server from auth context

updatedAtstring date-time nullable

Set by server

updatedBystring nullable

Set by server from auth context

hideFromUiboolean nullable

When true, topic is hidden from the preference center UI (e.g. SMART campaign topics). Cannot be changed after creation.