API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve group profiles by email address

This method will retrieve one or more profiles that are part of a group by using an emailAddress of the group's primary profile.

The response will include up to 50 profiles that belong to the group. If more than 50 profiles are found, the API returns a 403-Forbidden.

The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.

Header Parameters

Authorizationstring Required

Authorization token

Query Parameters

emailAddressstring Required

The email address associated with the primary profile of the group, used to retrieve all profiles within the group.

emailTypestring

Name of the email type associated with the specified email address. This allows you to filter the results to a specific email type.

groupTypestring Required

Name of the group type present on the primary profile of the group.

groupNamestring

Optional parameter used to filter the profiles returned based on the specified group name.

impliedboolean

Boolean flag, when set to true, returns both implied and expressed preferences. Expressed preferences are explicitly stated by individuals, while implied preferences are inherited from the parent Filter when no explicit preference is provided. The Match Type field on a preference record indicates whether a preference is expressed or implied. This distinction is applicable only when the Preference Propagation feature is enabled in your account. Otherwise, all preferences are output w...

includeConsentHistoryboolean

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

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

Response

200
Object

Response Attributes

ProfileIdinteger
IsActiveboolean
Editedobject

Show child attributes

RegistrationConfirmedboolean
CustomerTypestring
PreserveConsentsboolean
PreservePreferencesboolean
CustomerNameobject

Show child attributes

DefaultLocalestring
UpdateStatusstring
ReasonCodestring
AlternateIdsarray

Show child attributes

Addressesarray

Show child attributes

Emailsarray

Show child attributes

PhoneNumbersarray

Show child attributes

ProfilePreferencesarray

Show child attributes

Consentsarray

Show child attributes

CustomFieldsarray

A collection of custom fields associated with the profile.

Show child attributes

Groupsarray

Show child attributes

ProfileTagsarray

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.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
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. See error description for more details.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. 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?