API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve Filter

Retrieve configuration for a specific Filter. You can optionally specify localeId to only retrieve text tags for the specified locale.

When requiring consent for a preference, specify it in the RequiredPreferenceConsents collection on the Filter. The TypeName field is required and should contain the name of an active consent type configured in your account. The DisplayOrder field is optional and is used for determining the order in which consents are displayed on customer-facing user interfaces. Deactivating a consent removes it from the RequiredPreferenceConsents collection. Reactivating a previously deactivated consent type does not automatically marks it as required again. Additionally, when a consent is required, you cannot edit the ChannelId associated with it.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Type of the data being sent in the request or the data that is expected in the response. Supports application/json.

Query Parameters

localestring

A valid locale ID associated with a text tag. If specified, the API response will only include text tags for the specified locale.

Path Parameters

clientIdstring

This is your MyPreferences Account Id.

filterIdstring

Id of the Filter you want to retrieve.

Response

200
Object
Success

Response Attributes

Filtersarray

Collection of Filters

Show child attributes

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.

Response Attributes

filtersarray

Collection of Filters

Nullable:
True

Show child attributes

401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.

Response Attributes

filtersarray

Collection of Filters

Nullable:
True

Show child attributes

403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
503
Object
The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?