Request Details

ITEM	VALUE
Description	Returns the details for a configured reward group. The response includes localized reward-group text when a locale is supplied.
Method	GET
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2.1/rewardgroup/[group_id]?api_key=[api_key]&__locale__=[lang_id]
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.
group_id	path / integer	Yes	Identifier of the reward group to retrieve.

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.
lang_id	query / string	No	Locale or language identifier used to translate title, description, category_name, activity_name, color, and size.

Response Body

The response is a reward-group object.

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
group_id	integer	8116	Unique identifier for the reward group.
title	string	Test Reward #7	Translated title displayed for the reward group.
description	string	Reward with variance and required shipping and phone	Translated reward-group description.
type	string (enum)	standard	Reward-group type. See Reward Type Values.
num_points	integer	5	Number of points required to redeem the reward.
date_start	string (ISO 8601 date-time)	2026-02-06T05:00:00Z	ISO 8601 date-time at which the reward group becomes active.
date_end	string (ISO 8601 date-time) or null	null	ISO 8601 date-time at which the reward group 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.
is_enabled	boolean	true	Whether the reward group is enabled.
category_name	string	Productos gratis	Translated reward category name.
quantity_remaining_total	integer	9999999	Total number of reward units remaining.
quantity_max_select	integer	2	Maximum quantity that can be selected during redemption.
shipping_required	boolean	false	Whether shipping information is required to redeem the reward.
phone_number_required	boolean	true	Whether a phone number is required to redeem the reward.
min_age	integer or null	null	Minimum member age required to redeem the reward, if configured.
terms_url	string (URI) or null	null	URL for the reward terms and conditions, if configured.
extra_data	object	{}	Additional reward-group data. Schema is customer-defined.
tags	array	[ { "id": 1, "name": "tag" } ]	Tags assigned to the reward group.
freq_cap	integer or null	null	Description pending.
freq_period_id	integer or null	null	Identifier of the frequency period, if configured.
freq_period_name	string or null	null	Name of the frequency period, if configured.
locked_by_activities	array	[ { "activity_id": 123, ... } ]	Activities that lock the reward group until their conditions are met.
images	array	[ { "image_order": 1, ... } ]	Images associated with the reward group.
variations	array	[ { "id": 1, ... } ]	Selectable reward variations.
min_tier	object	{ "level_id": 376, "name": "Gold" }	Minimum loyalty tier required to redeem the reward, if configured.
segment_link	object	{ "name": "5x login", ... }	Segment eligibility configuration for the reward group, if configured.

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.

locked_by_activities

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
activity_id	integer	123	Unique identifier for the activity.
activity_name	string	click the link	Translated activity name.

images

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
image_order	integer	1	Display order of the image.
img_url	string (URI)	https://cdn.crowdtwist.com/img/v2/image.jpg	URL of the image.

variations

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
id	integer	1	Unique identifier for the variation.
current_quantity	integer	4	Current quantity available for the variation.
reference_id	string	46a6sd	Reference identifier for the variation.
color	string	Neon	Translated variation color.
size	string	42	Translated variation size.

min_tier

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
level_id	integer	376	Unique identifier for the loyalty tier.
name	string	Gold	Loyalty tier name.

segment_link

FIELD	TYPE	SAMPLE VALUE	DESCRIPTION
name	string	5x login	Name of the linked segment.
subscription_id	integer	123	Identifier for the segment subscription.
eligibility_type	string	inclusion	Type of eligibility rule applied by the segment.

Sample Response Body