---
title: "Get user's welcome bonus, if eligible"
method: GET
path: "/v1/client/promotions/welcome-bonus"
tags: ["User"]
---

# Get user's welcome bonus, if eligible

`GET /v1/client/promotions/welcome-bonus`

Get user's welcome bonus, if eligible.

## Response `200`

OK

- object
  - `data` PromotionsWelcomeBonus
    - `spin_details` WelcomeBonusSpinDetails — Details about the spin wheel for the user
      - `is_available` boolean, required
      - `percentage_period_seconds` integer, required
      - `prize_pool` WelcomeBonusWheelPrize[], required — Available rewards
        - `type` 'FLAT_AMOUNT' | 'PERCENTAGE', required — The type of reward
        - `weight` number, float, required — The weight of the reward; between 0 and 1
        - `prize_data` number, float, required
    - `user_reward_currency` number, float — The once off user reward currency a user will receive upon claiming the welcome bonus
    - `bonus_type` 'FLAT_AMOUNT' | 'PERCENTAGE'
    - `value` number, float — The percentage value which will be used to calculate the user reward upon the completed survey, offer, etc. reward
    - `duration_seconds` integer — The amount of seconds that the welcome bonus is active since the time it was claimed by the user.
    - `allowed_demands` string[]
    - `claimed_at` string, date-time — When the user has claimed the welcome bonus eligibility.
    - `expires_at` string, date-time — Welcome bonus expiration timestamp, calculated as duration_seconds after the time the welcome bonus was claimed.

---

[API](https://skmtc.net/bitlabs/apis/bitlabs-client-api.md) · [All operations](https://skmtc.net/bitlabs/apis/bitlabs-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitlabs/bitlabs-client-api/revisions/99209a6285bf/schema)