Request Details

Item	Value
Description	Returns the list of active rewards available to a specific user.
Method	GET
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2/users/[user_id]/rewards?api_key=[api_key]&id_type=[id_type]

Request

Field Name	Sample Value	Required	Format	Notes
URL PARAMETERS
user_id	alice@crowdtwist.com	Yes	String	Unique ID of the user for whom activities will be returned: Options: – Email Address – Facebook User ID – Twitter User ID – CrowdTwist ID – Third Party ID – Username – Mobile Phone Number
QUERY PARAMETERS
api_key	QWERTYUIOP	Yes	String
id_type	email	No	String	Type of ID being Sent: Options: – email – facebook_user_id – twitter_user_id – id (CrowdTwist ID) – default ID if id_type is not specified – third_party_id – username – mobile_phone_number

Response

Response Body

Field Name	Sample Value	Required	Format	Description
id	64	Yes	String	Internal CrowdTwist reward id.
title	10% Off Coupon	Yes	String	The title of the reward.
description	Receive a 10% off coupon when you redeem 1000 points.	Yes	String	The description of the reward.
num_points	1000	Yes	String	The number of points a user must redeem to be issued the reward.
image	http://www.imagestorage.com/image	Yes	URL	The reward image.
is_enabled	1	Yes	Integer	Boolean value indicating if reward is enabled.
category_id	16	No	String	ID of category rewards is in.
date_start	1490688000	No	Unix timestamp	Date reward initially becomes available.
date_end	1493193600	No	Unix timestamp	Date reward stops being available.
date_end_redeemable	1425404945	No	Unix timestamp	If Sweepstakes – end date redeemable
no_end_date	1	No	Integer	Boolean value indicating if there is no end date.
total_quantity	200	No	Integer	Total number of this reward available.
current_quantity	100	No	Integer	Current number of this reward available.
max_select_quantity	3	No	Integer	Maximum number of this reward a user can select.
max_per_user	5	No	Integer	Maximum number of this reward a user can redeem.
is_shipping_required	1	No	Integer	Boolean value indicating if shipping is required.
is_phone_number_required	1	No	Integer	Boolean value indicating if phone number is required.
min_age	13	No	Integer	Minimum age a user must be to redeem this reward.
is_digital_download	1	No	Integer	Boolean value indicating if reward is digital download.
reference_id	46a6sd	No	String	Optional custom identifier that can be set in Control Center per reward/reward variation.
total_coupons	10000	No	Integer	If code reward – Number of coupons uploaded.
remaining_coupons	4678	No	Integer	If code reward – Number of coupons remaining unredeemed.
sweepstakes_winners	100	No	Integer	If Sweepstakes – total number of potential sweepstakes winners.
extra_data	{"email_template": "redemption", “internal_name” : “percentoff”}	No	JSON	JSON blob of extra data set by client in Control center.
reward_terms	http://cdn.crowdtwist.com/file /67d/reward_terms.pdf	No	String	If a sweepstakes reward with a terms & conditions file, the URL of the PDF. Note: agreement of this must be controlled via the redemption method.
min_tier_id	null	No	String	The minimum tier that a user needs to be at in order to perform this activity. List of ID values will be provided by the CrowdTwist team.
freq_cap	1	No	Integer	The number of redemptions that can table place based on the freq_period_id and freq_period_name.
freq_period_id	2	No	Integer	The id of the freq_period_name value.
freq_period_name	Calendar Day	No	String	The time period for which redemptions can take place.
point_cap_balance	250	No	Integer	Remaining balance on the point cap. Members can redeem until cap balance is greater than redemption value cap_balance would be null if cap is not defined for a category cap_balance would be 0 or greater if there is a cap defined for a category
category_point_cap_reset_date	1510221600	No	UNIX Timestamp	Date and time at which reward can be redeemed again
segment		No	Object	Object that contains the segment information
— name	“New York Members”	No	String	Name of the segment
— subscription_id	2	No	Integer	Identifier of the segment

Error Responses

Field Name	Sample Value	Required	Format	Description
error	param_error	Yes	String	A machine readable code that describes the error.
message	Missing the user_id parameter	Yes	String	A short, descriptive sentence detailing the error.

Error Response Codes

Error	Message
input_error	The input provided in invalid or formatted incorrectly.
internal_error	Something went wrong on our end.
page_not_found	The requested page does not exist or has been removed.
param_error	A missing or invalid parameter is included in the request.
no_rewards	There are no rewards available to this user.

Samples

Sample Request Body

Sample Response Body

Sample Error Response