Get list of reward chains

Get list of reward chainsServer-sideAdmin

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

Gets 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

ID del proyecto. Encontrará este parámetro en su cuenta Publisher junto al nombre del proyecto.

Example: 44056

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0). Example: offset=0
enabled	integer Filtrar elementos por la marca `is_enabled`.

Responses

200

La lista de cadenas de recompensas se recibió correctamente.

401

Autenticación básica no superada o errónea. Asegúrese de haber utilizado la autenticación básica o las credenciales correctas.

Request samples

Response samples

application/json

{"has_more": true,
"items": [{"date_end": "2021-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"description": {"en": "Reward chain description"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Reward chain long description"
},
"name": {"en": "Reward chain"
},
"order": 1,
"recurrent_schedule": null,
"reward_chain_id": 1,
"value_point": {"description": {"en": "Value points for standard reward system."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_clan": false,
"is_enabled": true,
"long_description": {"en": "Value points given to users to get new rewards in a reward chain."
},
"media_list": [ ],
"name": {"en": "Reward VP 1"
},
"order": 1,
"sku": "reward_vp_1",
"type": "value_point"
}
},
{"clan_type": "guild",
"date_end": "2023-04-15T18:16:00+05:00",
"date_start": "2022-04-15T18:16:00+05:00",
"description": {"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Clan reward chain long description."
},
"name": {"en": "Clan reward chain"
},
"order": 1,
"popup_header": {"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"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."
},
"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"
},
"reward_chain_id": 2,
"value_point": {"description": {"en": "Value points for clan reward system."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_clan": true,
"is_enabled": true,
"long_description": {"en": "Value points given to clans to get new rewards in a reward chain."
},
"media_list": [ ],
"name": {"en": "Clan Reward VP 1"
},
"order": 1,
"sku": "clan_value_point_sku_1"
}
}
]
}