GET/v1/preferenceagents

Get preferenceagents

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 objectPreferenceAgent
idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
namestringnullablemax length 64
descriptionstringnullablemax length 512
businessUnitstringnullable
slugstringnullable
statusstringnullable
redirectUrlstringnullable
welcomestringnullable
farewellstringnullable
elementsarray of objectPreferenceAgentElementnullable
idstringnullable
groupstringnullable
refIdstringnullable
askstringnullable
requiredboolean
confirmboolean
orderinteger (int32)
resolvedNamestringnullable
resolvedLabelstringnullable
resolvedDescriptionstringnullable
resolvedTypestringnullable
resolvedChannelsIdsarray of stringnullable
resolvedFrequenciesIdsarray of stringnullable
orphanedboolean
accentstringnullable
avatarstringnullable
bubblestringnullable
densitystringnullable
showProgressboolean
showCountboolean
tonestringnullable
languagestringnullable
stayOnTopicboolean
allowSkipboolean
allowLookupboolean
allowUnsubscribeboolean
writeContactboolean
createContactboolean
fallbackPageIdstringnullable
is_deletedboolean
deleted_atstring (date-time)nullable
curl --request GET \
  --url 'https://api.4comply.io/v1/preferenceagents' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id'