Find Members / Verify Member
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/members
memberIdentifierstring<p>External account identifier (e.g. loyalty account number).</p>
memberIdsarray<p>Comma-separated internal member identifiers. Return the profile details for the matching memberIds.</p>
firstNamestringSearch for members by first name.
middleNamestringSearch for members by middle name.
lastNamestringSearch for members by last name.
includeReversedNamebooleanSearches for both "firstName lastName" and "lastName firstName" combinations
statusCodestringLimits return to all members of this status
companystringLimits return based on company
accountTypestringLimits return based on accountType
tierCodestringLimits return to all members of this tier
emailstringLimits return based on email address
phoneNumberstringLimits return based on phone number
citystringLimits return to all members with this City demographic
stateCodestringLimits return to all members with this state code demographic
zipstringLimits return to all members with this Zip demographic
countryCodestringLimits return to all members with this country code demographic
aliasIdentifierstringLimits return to all members with this alias
aliasTypestring<p>Used in conjunction with aliasIdentifier, limits return to all members with this aliasType</p>
testAccountboolean<p>If using, only test accounts will be returned</p>
includeAddressesbooleanInclude member's addresses
includeEmailsbooleanInclude member's emails
includePhonesbooleanInclude member's phones
includePaymentCardAccountsboolean<p>Include member's payment (credit) card accounts. Defaults to false.</p>
includeAliasesbooleanInclude member's aliases
includeCurrenciesbooleanInclude member's currencies
includePreferencesbooleanInclude member's preferences
includeAuthorizedMembersbooleanInclude authorized members for the member. Authorized members are people identified who are allowed to make changes to the account when contacted by Member Services
includeMemberListsbooleanIncludes the active member lists
includeOnlyDisplayableListsboolean<p>This parameter only applies when includeMemberLists is set to true; it has no effect otherwise. When set to true, only member lists with the displayInCC flag enabled are returned.Tally CC by default is only authorized to see lists that has this flag set to true. When set to false, all member lists are returned.</p>
includeInactiveboolean<p>Returns inactive emails, phones, payment cards, and member lists in addition to active ones.</p>
matchModestring<p>Specifies the type of search behavior to use with the provided query parameters. This setting controls wildcard placement and matching logic. Available options include -, Start - Applies wildcard matching from the beginning of the search term ,Exact - Performs precise matching without wildcard expansion</p>
acceptstringGenerated from available response content types
200Success
400Bad request
401Unauthorized
403Forbidden
500Internal error
curl --request GET \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/members?includeReversedName=boolean&includeOnlyDisplayableLists=boolean&includeInactive=boolean' \
--header 'accept: application/json'