Request Details

ITEM	VALUE
Description	Returns the configured reward list for a widget and loyalty member. Localized widget and reward text is returned when a locale is supplied.
Method	GET
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2/widgets/reward/[widget_id]/[user_id]?api_key=[api_key]&id_type=[id_type]&__locale__=[language]
Content Type	application/json

Host and Path Parameters

PARAMETER	LOCATION / TYPE	REQUIRED	DESCRIPTION
environment	host / string	Yes	Environment prefix used to construct the client-specific CrowdTwist API host. Deployment-specific value.
client_id	host / string	Yes	Client identifier embedded in the CrowdTwist API host name. Deployment-specific value.
widget_id	path / integer	Yes	Identifier of the reward widget to retrieve.
user_id	path / string	Yes	Identifier for the loyalty member whose rewards are returned.

Request Query Parameters

PARAMETER	LOCATION / TYPE	REQUIRED	DESCRIPTION
api_key	query / string	Yes	API key used for client identification and authentication. Treat as a secret and transmit only over HTTPS.
id_type	query / string	Yes	Identifies how user_id is interpreted. See ID Type Values.
__locale__	query / string	No	Language or locale used to translate header_text, title, description, and category_name.

id_type Values

VALUE	DESCRIPTION
id	CrowdTwist member identifier.
email	Member email address.
third_party_id	External identifier associated with the member.
username	Member username.
mobile_phone_number	Member mobile phone number.

Response Body

Top-Level Object

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
details	object	{ "widget_name": "Reward List", ... }	Presentation metadata for the widget.
items	array	[ { "group_id": 1, ... } ]	Ordered collection of rewards returned for the member.

details

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
widget_name	string	Reward List	Widget name (internal).
header_text	string	Canjea tus puntos	Translated header text displayed by the widget.

items

Each array element represents a reward. The array is ordered using sort_order.

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
sort_order	integer	1	Display order of the reward within the widget.
group_id	integer	1	Identifier of the reward group.
name	string	Get a TShirt	Reward name (internal).
title	string	Consigue una camiseta	Translated title displayed for the reward.
description	string	Canjea tus puntos por una camiseta del programa.	Translated reward description.
img_url	string (URI)	https://cdn.crowdtwist.com/.../image.png	URL of the reward image.
type	string (enum)	standard	Reward type. See Reward Type Values.
date_start	string (ISO 8601 date-time)	2026-02-06T05:00:00Z	ISO 8601 date-time at which the reward becomes active.
date_end	string (ISO 8601 date-time) or null	null	ISO 8601 date-time at which the reward ends; null when no end date is set.
date_end_redeemable	string (ISO 8601 date-time) or null	null	For sweepstakes rewards, the ISO 8601 date-time through which the sweepstakes can be redeemed.
num_points	integer	5	Number of points required to redeem the reward.
category_name	string	Productos gratis	Translated reward category name.
quantity_remaining	integer	998	Number of reward units remaining.
extra_data	object	{}	Additional reward-specific data. Schema is customer-defined.
tags	array	[ { "id": 1, "name": "tag" } ]	Tags assigned to the reward.

Reward Type Values

VALUE	DESCRIPTION
standard	Standard reward.
sweepstake	Sweepstake reward.
digital	Digital reward.
code	Code reward.
external	External reward.

tags

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
id	integer	1	Unique identifier for the tag.
name	string	tag	Tag name.

Sample Response Body