Skip to content
Reward Claims

List Selectable Reward Combinations

Returns activities the Client qualified for that require choosing one of several reward combinations, with each activity's combinations and choice state, for showing the choose-reward entry and the grant progress of chosen rewards in the rewards center. When state is unchoiced, call POST /v1/activity/rewards/choice_reward_group to submit a choice.

GEThttps://api.lbkrs.com/v1/activity/rewards/reward_groups

Responses

HTTP 200The request succeeded. The response body contains the result of the “List selectable reward combinations” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
activitiesarray<object>

Activities that require a reward choice

Child attributes
idinteger

Activity ID; pass it as activity_id when choosing

rule_idinteger

Qualification rule ID; pass it as rule_id when choosing

namestring

Activity name

descriptionstring

Activity description

choice_tipstring

Hint shown when choosing a reward

statestring

Activity reward state:

  • unchoiced - Qualified; a reward combination is waiting to be chosen
  • sending - Chosen; being granted
  • sent - Granted
  • expired - Expired
  • canceled - Canceled
Values
unchoiced
sending
sent
expired
canceled
chosen_groupinteger

ID of the chosen reward combination; meaningless before a choice is made

groupsarray<object>

Selectable reward combinations

Child attributes
idinteger

Reward combination ID; pass it as group_id when choosing

descriptionstring

Combination description

rewardsarray<object>

Rewards in the combination

Child attributes
titlestring

Reward name

descriptionstring

Reward description

goodsobject

Physical prize

Child attributes
statusinteger

Single reward status:

  • 0 - Pending submission
  • 1 - Being granted
  • 2 - Granted
  • 3 - Grant failed
  • 4 - Grant canceled (for example, retention requirement not met)
  • 5 - In retention period
Values
0
1
2
3
4
5
couponobject

Card reward

Child attributes
typestring

Card type; same values as card_type in GET /rewards/card_list

statusinteger

Single reward status:

  • 0 - Pending submission
  • 1 - Being granted
  • 2 - Granted
  • 3 - Grant failed
  • 4 - Grant canceled (for example, retention requirement not met)
  • 5 - In retention period
Values
0
1
2
3
4
5
Whale Docs