GET/v1/preferencepages

Get preferencepages

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Query parameters

Filtersstring
Sortsstring
Pageinteger (int32)minimum 1maximum 2147483647
PageSizeinteger (int32)minimum 1maximum 2147483647

Responses

array of objectPreferencePage
idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
namestringnullablemax length 64
descriptionstringnullablemax length 512
statusstringnullable
form_Idstringnullable
htmlstringnullable
headerHtmlstringnullable
footerHtmlstringnullable
customCssstringnullable
headerScriptstringnullable
footerScriptstringnullable
businessUnitstringnullable
i18n_languagestringnullable
uiTranslationsobjectnullable
{key}objectnullable
includeEmailSearchboolean
includeUnsubscribeboolean
redirectUrlstringnullable
generalCorePreferencesarray of objectGeneralCorePreferencenullable
idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
typestringnullable
orderinteger (int32)
cssClassstringnullable
formIdstringnullable
controlIdstringnullable
contentstringnullable
translationsobjectnullable
controlNamestringnullable
controlHtmlstringnullable
childrenarray of GeneralCorePreferenceGeneralCorePreferencenullable
is_deletedboolean
deleted_atstring (date-time)nullable
curl --request GET \
  --url 'https://api.4comply.io/v1/preferencepages' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id'