Sign in

v1

latestOpenAPI 3.0.22026-07-1319091298.3 KB
privacy-centers

Retrieve a list of privacy centers

Returns a list of all the privacy centers the user has access to

get/privacy-centers

Query parameters

privacy_center_idstring

The ID of the privacy center

Response

A list of PrivacyCenter objects

idstring required

Privacy Center ID

namestring required

Display name of the privacy center (usually the company or website name)

websitestring uri

URL of the website linked to the privacy center

custom_domainsstring[]

Sub-domains that the privacy center should be served on (without http or / ; example: privacy.domain.com)

legal_namestring

Full legal name of the company

display_cookies'list' | 'choices' | 'none'

How to display the cookies section in the privacy center?

privacy_policystring

The privacy policy to display in the privacy center formatted with Markdown (English)

contentobject

Texts of the privacy center

languagesstring[]

Languages enabled in the privacy center (two-letter codes or two-letter language and two-letter country code); an empty list or a null value will enabled all available languages

auth_requiredboolean

Whether end users must be authenticated when accessing a privacy center

organization_idstring

The ID of the organization that owns this privacy center

created_atstring date-time

Creation date of the privacy center

updated_atstring date-time

Last update date of the privacy center

versionnumber

Revision number of the privacy center object