Household Activity History


Request Details

Item Value
Description Returns the activity history of a household.
Method GET
Endpoint https://[environment]api[client_id].crowdtwist.com/v2/household/[household_id]/activity_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

Field Name Sample Value Format Description
activity_id 3823478 Integer The id of the activity performed.
name "download our app" String The name of the activity.
num_points 20 Integer The points awarded for this activity completion.
date_awarded “2020-11-25T20:17:34Z” String (ISO 8601) The date this activity was awarded.
completed_by 238901577 Integer The member who performed this activity (CrowdTwist User ID)


Sample Successful Response 

{
    "paging": {
        "total": 1,
        "pages": 1,
        "prev_page": null,
        "next_page": null
    },
    "activities": [
        {
            "activity_id": 3823478,
            "name": "download our app",
            "num_points": 20,
            "date_awarded": "2020-11-25T20:17:34Z",
            "completed_by": 238901577
        }
    ]
}

Error Responses

Error Code Description
404 Unable to find household.