Household Redemption History


Request Details

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


Request

Field Name Sample Value Required Format Notes
URL PARAMETERS
household_id 10 Yes Integer The id of the household.
QUERY STRING PARAMETERS
api_key QWERTYUIOP Yes String  
page 3 No Integer  
page_size 10 No Integer  


Successful Response

NOTE: This endpoint will return the same response as the User Redemption History with the addition of the below fields.

Field Name Sample Value Format Description
household_breakdown (See below) Array of breakdown objects The point breakdown across household members for this redemption.
redeeming_user_id 238901577 Integer The id of the user who performed this redemption.

household_breakdown

Field Name Sample Value Format Description
user_id 227796450 Integer The id of a member who contributed points to this redemption.
num_points 200 Integer The number of points that this member contributed to the redemption.


Sample Successful Response 

{
    "paging": {
        "total": 1,
        "pages": 1,
        "prev_page": null,
        "next_page": null
    },
    "redemptions": [
        {
            "household_breakdown": [
               {
                   "user_id": 238901577,
                   "num_points": 200
               }
            ],
            "redeeming_user_id": 238901577,
            ... See User Redemption History Response Object
        }
    ]
}

Error Responses

Error Code Description
404 Unable to find household.