Get current user's reward chains

Get current user's reward chainsClient-side

get/v2/project/{project_id}/user/reward_chain

Client endpoint. Gets the current user’s reward chains.

Attention

All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0

Responses

200

The user’s reward chain was successfully retrieved.

Request samples

Response samples

application/json

{"has_more": false,
"total_items_count": 1,
"items": [{"reward_chain_id": 10,
"name": "Weekly quest",
"description": "Big weekly quest",
"long_description": "You can get a lot of additional items just by shopping during the week",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2023-04-25T18:16:00+05:00",
"value_point": {"sku": "value_point_1",
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"description": null,
"long_description": null,
"amount": 130
},
"clan_type": null,
"top_contributors": null,
"steps": [{"step_id": 1,
"name": "Level 1",
"is_claimed": true,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {"amount": 100
},
"reward": [{"sku": "box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
},
{"sku": "box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
}
]
},
{"step_id": 2,
"name": "Level 2",
"is_claimed": false,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {"amount": 200
},
"reward": [{"sku": "box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
},
{"sku": "box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
}
]
}
],
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"popup_header": null,
"popup_instruction": null,
"popup_image_url": null
},
{"reward_chain_id": 12,
"name": "Weekly clan quest",
"description": "Major weekly clan quest.",
"long_description": "You and your clan members can get additional items for shopping during a certain month.",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 2,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2023-10-15T18:16:00+05:00",
"value_point": {"sku": "clan_value_point_sku_1",
"name": "Clan Reward VP 1",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"description": "Value points for clan reward system.",
"long_description": "Value points given to clans to get new rewards in a reward chain.",
"amount": 80
},
"clan_type": "guild",
"top_contributors": [{"name": "Rabbit",
"contributed_amount": 100
},
{"name": "Rocket",
"contributed_amount": 80
},
{"name": "Rain",
"contributed_amount": 40
}
],
"steps": [{"step_id": 1,
"name": "Level 1",
"is_claimed": true,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {"amount": 100
},
"reward": [{"sku": "box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
},
{"sku": "box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
}
]
},
{"step_id": 2,
"name": "Level 2",
"is_claimed": false,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {"amount": 200
},
"reward": [{"sku": "box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
},
{"sku": "box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
}
]
}
],
"recurrent_schedule": {"interval_type": "monthly",
"reset_next_date": 1746057600
},
"popup_header": "How to unlock rewards",
"popup_instruction": "You should be a clan member to get clan rewards. You join a clan when a clan member invited you to the clan, and you accepted the invite. You can create your own clan.",
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png"
}
]
}