Household Detail

GET 
/client/users/:correlation_id/household/members

Used to get details about a specific member household.

Redemptions cannot be made using PHONE_NUMBER as the X-Identifier-Type, so if it is used, then attributes for redeemable balances are returned in the response as "0" values. If PHONE_NUMBER is used as the unique identifier for the Start Session call before this call, then all Redeemable Balances information for the household and for the account that initiated the session are shown as 0, as are redeemable balances for all other members. Redemptions cannot be made using PHONE_NUMBER as the X-Identifier-Type.

Request

Body

This request does not have a body.

Response

Attributes	Definition	Format	Notes
household	Contains all information about the household.	Object
id	Unique identifier for the household.	String
formedDate	Date the household was formed in ISO 8601 format.	String
balance	Contains information about household aggregated balance	Object
totalpointsBalance	The total current point balance for the household.	Number
totaldollarBalance	The total current dollar balance for the household.	Number
totalavailablePointsBalance	The total balance of points available for redemption for the household.	Number	This is their points balance less holds on their account.
totalavailableDollarBalance	The total balance of dollars available for redemption for the household.	Number	This is their dollar balance less holds on their account.
userMinRedeemPoints	Minimum number of points the household can redeem in one transaction.	Number
userMaxRedeemPoints	Maximum number of points the household can redeem in one transaction.	Number
userMinRedeemDollars	Minimum number of dollars the household can redeem in one transaction.	Number
userMaxRedeemDollars	Maximum number of dollars the household can redeem in one transaction.	Number
membersCount	The number of members that are in the household.	Number
members	Contains information about the members in the household.	Object within an array	The Primary member can access information on all household members; Secondary can access only their own information.
loyaltyId	Unique loyalty identifier for member.	String
accountId	Unique account identifier for member.	String
firstName	First name of member.	String
lastName	Last name of member.	String
email	Email address of member.	String
joinedDate	When the member joined the household in ISO 8601 format.	String
household	Unique identifier for the household.	String
householdRole	The member's role within the household.	Enum: "PRIMARY" or "SECONDARY"
balance	Contains various information about the member's points and dollars balance.	Object
pointsBalance	The balance of points associated with the member account.	Number
dollarBalance	The balance of dollars associated with the member account.	Number
availablePointBalance	The number of points currently available for redemption.	Number	Total points less any holds or reservations.
availableDollarBalance	The number of dollars currently available for redemption.	Number	Total dollars less any holds or reservations.
redeemablePointBalance	The number of points that can currently be redeemed.	Number	The program may have a minimum number of points that can be redeemed on one transaction, a maximum, and increments (such as every 25,000 points).
redeemableDollarBalance	The number of dollars that can currently be redeemed.	Number	The program may have a minimum number of dollars that can be redeemed on one transaction, a maximum, and increments (such as every $10).

Error Responses

TBD

Request

Responses

200

200 - Primary Member with View_HH privilege

Response Headers

Date
Example: Wed, 05 Apr 2023 02:44:11 GMT
Content-Length
Example: 1321
Connection
Example: keep-alive
x-amzn-RequestId
Example: cdc9e70c-591e-4da1-8e1c-c4b704893470
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-f19c35e9-1035-4879-8066-19742e5e792b
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: April 5th 2023, 2:44:11
x-amz-apigw-id
Example: C4gDBGNxIAMFgMg=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-642ce079-730e950633316eea547ac00f;Sampled=0;lineage=815bc71e:0