Get list of 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 10 items per response. To get more data page by page, use limit and offset fields.

SecuritybasicAuth

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
enabled	integer Filter elements by `is_enabled` flag.

Responses

200

The list of reward chains was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

Request samples

Response samples

application/json

{"has_more": true,
"items": [{"name": {"en": "Reward chain"
},
"reward_chain_id": 1,
"description": {"en": "Reward chain description"
},
"long_description": {"en": "Reward chain long description"
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"date_start": "2020-04-15T18:16:00+05:00",
"date_end": "2021-04-15T18:16:00+05:00",
"value_point": {"sku": "reward_vp_1",
"name": {"en": "Reward VP 1"
},
"type": "value_point",
"is_enabled": true,
"description": {"en": "Value points for standard reward system."
},
"long_description": {"en": "Value points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [ ],
"order": 1,
"is_clan": false
},
"recurrent_schedule": null
},
{"name": {"en": "Clan reward chain"
},
"reward_chain_id": 2,
"description": {"en": "Clan reward chain description."
},
"long_description": {"en": "Clan reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"date_start": "2022-04-15T18:16:00+05:00",
"date_end": "2023-04-15T18:16:00+05:00",
"value_point": {"sku": "clan_value_point_sku_1",
"name": {"en": "Clan Reward VP 1"
},
"is_enabled": true,
"description": {"en": "Value points for clan reward system."
},
"long_description": {"en": "Value points given to clans to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [ ],
"order": 1,
"is_clan": true
},
"recurrent_schedule": {"day_of_month": null,
"day_of_week": 2,
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00",
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"interval_type": "weekly",
"reset_next_date": 1677553200,
"time": "11:00:00+08:00"
},
"popup_header": {"en": "How to unlock rewards"
},
"popup_instruction": {"en": "You must be a clan member in order to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"clan_type": "guild"
}
]
}