Retrieve profiles by preference attributes
This method retrieves one or more profiles containing preferences that meet the specified attribute criteria. It selectively returns only those preferences that contain all of the specified attribute criteria.
Moreover, this method facilitates filtering based on multiple preference attributes, with parameters passed as an array. The initial key and value combination commence with index 0.
This method returns up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden.
All active consents, custom fields, groups, tags, and preferences for which you have permissions will be returned in the response.
To illustrate, suppose you want to search for a profile with the preference attribute key "alpha" and a value of "couch," as well as another attribute key "beta" with a value of "book." In that case, you can use the following request as an example.
Header Parameters
Authorization token
Query Parameters
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
Specifies whether to retain the contact element consents or deactivate them. To retain the contact element consents, set the value as true. If set to false, the contact element consents will be deactivated. This setting defaults to true, if not specified.
Specifies whether to retain the preferences or deactivate them. To retain the preferences, set the value as true. If set to false, the preferences will be deactivated. This setting defaults to true, if not specified.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
A collection of additional unique identifiers that can be associated with a profile. For example, customer identifiers from other applications such as Salesforce, Marketo or Facebook can be stored as AlternateIds.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
A collection of preferences associated with the user profile. Profile preferences are tied to the user’s profile. These preferences are not associated with any contact element on the profile.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
What made this section unhelpful for you?