# Obtenha as cadeias de recompensa do usuário atual

Ponto de extremidade do cliente. Obtém as cadeias de recompensa do usuário atual.

AtençãoTodos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.

Endpoint: GET /v2/project/{project_id}/user/reward_chain
Version: 2.0.0
Security: XsollaLoginUserJWT

## Path parameters:

  - `project_id` (integer, required)
    ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
    Example: 44056

## Query parameters:

  - `limit` (integer)
    Limite da quantidade de elementos na página.
    Example: 50

  - `offset` (integer)
    Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

## Response 200 fields (application/json):

  - `has_more` (boolean)
    Usado como um indicador de que há mais páginas.
    Example: true

  - `items` (array)

  - `items.clan_type` (string,null)
    Tipo de clã.
    Enum: "clan", "guild", "faction", "community", "team", "squad", "alliance", "association", "coalition", "union", "group", "civilizations", "dynasty", "order", "league", "brotherhood", "kingdom", "organization", "house", "empire", "tribe", "cartel", null

  - `items.date_end` (string,null)
    Data em que sua promoção da cadeia de recompensas termina. Pode ser null. Se date_end for null, a cadeia de recompensas terá um tempo ilimitado.
    Example: "2020-04-15T18:16:00+05:00"

  - `items.date_start` (string)
    Data em que sua cadeia de recompensas começa.
    Example: "2020-04-15T18:16:00+05:00"

  - `items.description` (string,null)
    Descrição da cadeia de recompensas.
    Example: "Major weekly quest"

  - `items.image_url` (string,null)
    URL da imagem.
    Example: "https://image.example.com"

  - `items.long_description` (string,null)
    Descrição longa da cadeia de recompensas.
    Example: "You can get a lot of additional items just by shopping during the week"

  - `items.name` (string)
    Nome da cadeia de recompensas.
    Example: "Weekly quest"

  - `items.order` (integer)
    Define a ordem do arranjo.
    Example: 1

  - `items.popup_header` (object,null)
    Objeto com traduções para um cabeçalho de uma janela pop-up de dica sobre uma cadeia de recompensas de clã. Duas letras minúsculas [código de idioma](https://developers.xsolla.com/pt/doc/pay-station/features/localization/).

  - `items.popup_header.ar` (string,null)

  - `items.popup_header.bg` (string,null)

  - `items.popup_header.cn` (string,null)

  - `items.popup_header.cs` (string,null)

  - `items.popup_header.de` (string,null)
    Example: "Wie man Belohnungen freischaltet"

  - `items.popup_header.en` (string,null)
    Example: "How to unlock rewards"

  - `items.popup_header.es` (string,null)
    Example: "Cómo desbloquear recompensas"

  - `items.popup_header.fr` (string,null)
    Example: "Comment débloquer des récompenses"

  - `items.popup_header.he` (string,null)

  - `items.popup_header.it` (string,null)
    Example: "Come sbloccare ricompense"

  - `items.popup_header.ja` (string,null)
    Example: "報酬をアンロックする方法"

  - `items.popup_header.ko` (string,null)

  - `items.popup_header.pl` (string,null)

  - `items.popup_header.pt` (string,null)

  - `items.popup_header.ro` (string,null)

  - `items.popup_header.ru` (string,null)

  - `items.popup_header.th` (string,null)

  - `items.popup_header.tr` (string,null)

  - `items.popup_header.tw` (string,null)

  - `items.popup_header.vi` (string,null)

  - `items.popup_image_url` (string,null)
    Imagem para a janela pop-up de dica de cadeia de recompensas de clã.
    Example: "https://image.example.com"

  - `items.popup_instruction` (object,null)
    Objeto com traduções para uma instrução de uma janela pop-up de dica sobre uma cadeia de recompensas de clã. Duas letras minúsculas [código de idioma](https://developers.xsolla.com/pt/doc/pay-station/features/localization/).

  - `items.recurrent_schedule` (object,null)
    Período de reinicialização recorrente da cadeia de recompensas.

  - `items.recurrent_schedule.interval_type` (any)

  - `items.recurrent_schedule.reset_next_date` (integer)
    Data e hora calculadas em que a cadeia de recompensas será redefinida na próxima vez (Unix Timestamp). Por exemplo, a cadeia de recompensas é redefinida mensalmente, a partir de 1º de março de 2024, às 01:00 no horário de Kuala Lumpur (GMT+8). A data e hora da próxima redefinição da cadeia de recompensas será 1º de abril de 2024 às 01:00 no horário de Kuala Lumpur (GMT+8), que equivale a 31 de março de 2024 17:00 GMT+0 ou '1711904400000' no formato Unix Timestamp.  Exemplo: '1711904400000'

  - `items.reward_chain_id` (integer)
    ID de cadeia de recompensas.
    Example: 9

  - `items.steps` (array)

  - `items.steps.is_claimed` (boolean)
    Se a recompensa da etapa foi reivindicada ou não.

  - `items.steps.name` (string)
    Nome da etapa.
    Example: "Level 1"

  - `items.steps.price` (object)

  - `items.steps.price.amount` (integer)
    O número de pontos de valor que um usuário reivindica na etapa.
    Example: 100

  - `items.steps.reward` (array)

  - `items.steps.reward.description` (string)
    Descrição do item.
    Example: "Super box with items"

  - `items.steps.reward.name` (string)
    Nome do item.
    Example: "Super box"

  - `items.steps.reward.quantity` (integer)
    Quantidade do item.
    Example: 2

  - `items.steps.reward.sku` (string)
    ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
    Example: "booster_mega_1"

  - `items.steps.reward.type` (string)
    Tipo de item.
    Example: "bundle"

  - `items.steps.step_id` (integer)
    ID da etapa.
    Example: 10

  - `items.top_contributors` (array)

  - `items.top_contributors.contributed_amount` (integer)
    Quantidade de pontos de valor ganhos pelo usuário.
    Example: 100

  - `items.top_contributors.name` (string)
    ID de usuário que é enviado à Xsolla durante o processo de autorização. O ID de usuário é usado para vincular o usuário ao seu projeto Login da Xsolla e é exibido como um apelido. Se você estiver usando autorização por [ID](https://developers.xsolla.com/pt/solutions/web-shop/create-web-shop/set-up-authentication/?tabs=100-UserIDAuth&link=100-UserIDAuth) de usuário, recomendamos passar o name parâmetro na [resposta do webhook](https://developers.xsolla.com/pt/webhooks/operation/user-validation-in-webshop/). Este parâmetro contém o nome de usuário que será usado como apelido.
    Example: "Rocket"

  - `items.value_point` (object)

  - `items.value_point.amount` (integer)
    Quantidade de pontos de valor.

  - `items.value_point.description` (string,null)
    Descrição do ponto de valor.

  - `items.value_point.is_clan` (boolean)
    Se o ponto de valor é usado em cadeias de recompensa de clã ou não.
    Example: true

  - `items.value_point.long_description` (string,null)
    Descrição longa do ponto de valor.

  - `items.value_point.name` (string)
    Nome do ponto de valor.

  - `items.value_point.sku` (string)
    ID de ponto de valor exclusivo.

  - `total_items_count` (integer)
    Número total de cadeias de recompensa no sistema.
    Example: 10