> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rabbithole.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# List user rewards

> Lists campaigns where the user has triggered and accrued rewards.



## OpenAPI

````yaml https://api-tbi.boost.xyz/v1/openapi.json get /v1/users/{address}/rewards
openapi: 3.1.0
info:
  title: Boost Time-Based Incentives SDK API
  version: 1.0.0
  description: >-
    Public /v1 API surface for the Boost TBI SDK. Internal Rabbithole, admin,
    Polymarket, and widget routes are intentionally excluded.
servers:
  - url: https://api-tbi.boost.xyz
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Campaigns
    description: Campaign discovery, detail, and stats endpoints.
  - name: Claims
    description: Claim proof and claim status endpoints.
  - name: Forwarder
    description: Boost Forwarder target discovery and direct deposit transaction builders.
  - name: Referrals
    description: >-
      Referral attribution: signed per-campaign binds, referrer earnings, and
      claim proofs.
  - name: Users
    description: User rewards and balance endpoints.
paths:
  /v1/users/{address}/rewards:
    get:
      tags:
        - Users
      summary: List user rewards
      description: Lists campaigns where the user has triggered and accrued rewards.
      operationId: listUserRewards
      parameters:
        - name: address
          in: path
          required: true
          description: EVM address. Responses normalize addresses to lowercase.
          schema:
            type: string
        - name: chainId
          in: query
          required: false
          description: Reward chain ID.
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
        - name: status
          in: query
          required: false
          description: Campaign statuses. May be repeated or comma-separated.
          schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
        - name: limit
          in: query
          required: false
          description: Maximum number of rows to return.
          schema:
            default: 20
            type: integer
            exclusiveMinimum: 0
            maximum: 100
        - name: offset
          in: query
          required: false
          description: Pagination offset.
          schema:
            default: 0
            type: integer
            minimum: 0
            maximum: 9007199254740991
        - name: X-Boost-Ref-Id
          in: header
          required: false
          description: >-
            Optional partner attribution reference ID. Values are manually
            assigned by Boost and must be at most 128 characters.
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
      responses:
        '200':
          description: User reward page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRewardsResponse'
        '400':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
components:
  schemas:
    UserRewardsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: object
                properties:
                  chainId:
                    type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  campaignIndex:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                required:
                  - chainId
                  - campaignIndex
                additionalProperties: false
              rewardToken:
                type: object
                properties:
                  address: {}
                  decimals:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  symbol:
                    type: string
                required:
                  - address
                  - decimals
                  - symbol
                additionalProperties: false
              balance:
                type: string
                pattern: ^(0|[1-9]\d*)$
              accumulatedRewards:
                type: string
                pattern: ^(0|[1-9]\d*)$
              claimable:
                type: string
                pattern: ^(0|[1-9]\d*)$
            required:
              - id
              - rewardToken
              - balance
              - accumulatedRewards
              - claimable
            additionalProperties: false
        total:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - data
        - total
      additionalProperties: false
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          enum:
            - INVALID_PARAMS
            - NOT_FOUND
            - RATE_LIMITED
            - INTERNAL_ERROR
            - INVALID_SIGNATURE
            - SELF_REFERRAL
            - ALREADY_BOUND
            - ALREADY_PARTICIPATING
            - CAMPAIGN_NOT_BINDABLE
            - INVALID_SESSION
            - WALLET_NOT_LINKED
            - REFERRER_NOT_LINKED
            - CYCLIC_REFERRAL
        details:
          anyOf:
            - {}
            - type: 'null'
      required:
        - error
        - code
        - details
      additionalProperties: false

````