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

# Customer Tier Progress

> Retrieve customer's current tier and progression within Gameball's loyalty program.

This API provides an overview of a customer's current tier and progression within Gameball's loyalty program. By retrieving the customer's current tier, progress level, and next tier details, this endpoint offers a clear view of their advancement within the tier structure.

<Info>
  **Security**: Requires **apikey** and **secretkey** headers.
</Info>


## OpenAPI

````yaml GET /api/v4.0/integrations/customers/{customerId}/tier-progress
openapi: 3.1.0
info:
  title: Gameball API
  description: >-
    Gameball REST API v4.0 - Complete API reference for integrating loyalty,
    gamification, and customer engagement features
  version: 4.0.0
servers:
  - url: https://api.gameball.co
security:
  - bearerAuth: []
paths:
  /api/v4.0/integrations/customers/{customerId}/tier-progress:
    get:
      summary: Get Customer Tier Progress
      description: >-
        This API provides an overview of a customer's current tier and
        progression within Gameball's loyalty program. By retrieving the
        customer's current tier, progress level, and next tier details, this
        endpoint offers a clear view of their advancement within the tier
        structure.
      operationId: getCustomerTierProgress
      parameters:
        - name: customerId
          in: path
          required: true
          description: >-
            Unique identifier for the customer that you can reference across the
            customer's whole lifetime. Could be a database ID, random string,
            email, or anything that uniquely identifies the customer.
          schema:
            type: string
        - name: expand
          in: query
          required: false
          schema:
            type: string
          description: 'Comma-separated expansions: tier,referrals'
        - name: lang
          in: header
          description: >-
            If the lang header is provided, the response will be returned in the
            specified language (e.g., en for English, fr for French). If this
            header is not included, the system will use the default language.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Customer tier progress retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerTierProgressResponse'
              example:
                current:
                  order: 1
                  name: Basic
                  minProgress: 0
                  icon: >-
                    https://cdn.gameball.co/uploads/gb-library/levels-icons/level-a1.webp
                next:
                  order: 2
                  name: Gold
                  minProgress: 190
                  icon: >-
                    https://s3.us-east-2.amazonaws.com/gameball.stg.uploads/uploads/gb-library/levels-icons/level-a1.webp
                progress: 50
      security:
        - apiKey: []
          secretKey: []
components:
  schemas:
    CustomerTierProgressResponse:
      type: object
      properties:
        current:
          $ref: '#/components/schemas/TierState'
          description: The customer's current tier.
        next:
          $ref: '#/components/schemas/TierState'
          description: The next tier the customer can reach.
        progress:
          type: number
          description: >-
            The current progress of the customer toward the next tier,
            reflecting their activity and engagement within the program. This
            value is calculated based on the client's chosen tiering-up method,
            indicating how close the customer is to advancing to a higher tier.
            Example: If the progress value is 1500 and the tiering-up method is
            total points earned, this means the customer has earned a total of
            1500 points toward their next tier. Possible Values: Total amount
            spent, Total points earned, Friends referred, Orders completed,
            Score.
    TierState:
      type: object
      properties:
        order:
          type: number
          description: >-
            This represents the numerical order of a tier. Higher numbers
            indicate higher tiers.
        name:
          type: string
          description: The name of the tier.
        minProgress:
          type: number
          description: >-
            The minimum amount of progress a customer needs to reach the next
            tier in the program. This represents the threshold that must be met
            for a customer to reach this tier. Example: if the minProgress is
            set to 2000, the customer must accumulate 2000 points, referrals, or
            completed orders (depending on the tiering method) to advance to the
            next tier.
        icon:
          type: string
          description: >-
            The URL for the icon associated with the tier. You can utilize this
            icon URL to display tier badges or indicators in your own custom
            interface, such as on customer profiles. This offers a visual
            representation of the customer's tier status.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````