Reward Details (legacy)
Request Details
| Item | Value |
| Description | This end point will lookup Reward by a particular reward variation ID. The Get Rewards API currently returns all rewards with their variation ID. |
| Method | GET |
| Endpoint | https://[environment]api[client_id].crowdtwist.com/v2/rewards/[reward_id]?api_key=[API_Key] |
Request
| Field Name | Sample Value | Required | Format | Notes |
| URL PARAMETERS | ||||
| reward_id | 123455678901 | Yes | Integer | Variation ID of the Reward. |
Samples
Sample Response Body
{
"id": "541043",
"title": "Test Reward #7",
"description": "Reward with variance and required shipping and phone",
"current_quantity": 4,
"num_points": 20,
"date_start": 1402057860,
"date_end": null,
"date_end_redeemable": null,
"is_enabled": 1,
"category_id": 2631,
"group_id": 8116,
"no_end_date": 1,
"total_quantity": 9999999,
"max_select_quantity": null,
"max_per_user": 2,
"is_shipping_required": 0,
"is_phone_number_required": 1,
"is_min_age_required": "0",
"min_age": null,
"is_digital_download": 0,
"sweepstake_winners": null,
"extra_data": null,
"show_as_locked": "0",
"featured_order_num": null,
"reference_id": "46a6sd ",
"color": "Neon",
"size": "42",
"total_coupons": 0,
"remaining_coupons": 0,
"freq_cap": null,
"freq_period_id": null,
"freq_period_name": null,
"additional_images": [],
"image": "https://cdn.crowdtwist.com/img/v2/image.jpg",
"reward_terms": null,
"min_tier_id": null,
"segment": null
}
Sample Error Response
{
"error": "page_not_found",
"message": "Reward with id 12345 not found"
}