Get Household Details

Request Details

Item	Value
Description	Returns the basic details of a household.
Method	GET
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2/household/[household_id]?api_key=[api_key]

Request

Field Name	Sample Value	Required	Format	Notes
URL PARAMETERS
household_id	10	Yes	Integer
QUERY STRING PARAMETERS
api_key	QWERTYUIOP	Yes	String

Successful Response

Field Name	Sample Value	Format	Description
household_id	3	Integer	The id of this household
name	"John's Household"	String	The name of this household
date_created	"2020-11-16T23:51:12.000Z"	String (ISO 8601)	The date this household was created
redeemable_points	200	Integer	The number of redeemable points currently contributed to this household
members	(See Below)	Array of member objects	The members that are currently part of this household

members

Parameter	Sample Value	Format	Description
id	240835353	Integer	The id of this member. (CrowdTwist ID)
date_joined	"2020-11-16T23:51:12.000Z"	String	The date this member joined the household
owner	true	Boolean	True if this member is the owner of the household

Sample Successful Response

{
    "household_id": 3,
    "name": "John’s Household",
    "date_created": "2020-11-16T23:51:12.000Z",
    "redeemable_points": 200,
    "members": [
        {
            "id": 240835353,
            "date_joined": "2020-11-16T23:51:12.000Z",
            "owner": true
        }
    ]
}

Error Responses

Error Code	Description
404	Unable to find household.