> ## 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.

# Get Customer Details

> Retrieve comprehensive customer information in Gameball, including personally identifiable information (PII).

This API provides access to comprehensive customer information in Gameball, including personally identifiable information (PII), using a unique `customerId`. Secured by a secret key, this endpoint ensures that sensitive customer data remains protected, offering a complete view of the customer profile for more personalized and secure interactions.

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


## OpenAPI

````yaml GET /api/v4.0/integrations/customers/{customerId}/details
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}/details:
    get:
      summary: Get Customer Details
      description: >-
        Retrieve comprehensive customer information including personally
        identifiable information (PII).
      operationId: getCustomerDetails
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier for the customer
      responses:
        '200':
          description: Customer details found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetailsResponse'
      security:
        - apiKey: []
          secretKey: []
components:
  schemas:
    CustomerDetailsResponse:
      type: object
      properties:
        customerId:
          type: string
          description: Unique identifier for the customer
        gameballId:
          type: number
          description: The customer's unique ID within the Gameball system
        customerAttributes:
          type: object
          description: Complete customer attributes including PII
          properties:
            displayName:
              type: string
              description: Display name for the customer.
            firstName:
              type: string
              description: Customer's first name.
            lastName:
              type: string
              description: Customer's last name.
            email:
              type: string
              description: Customer's email address.
            gender:
              type: string
              description: Customer's gender.
            mobile:
              type: string
              description: Customer's mobile number.
            dateOfBirth:
              type: string
              description: Customer's date of birth.
            joinDate:
              type: string
              description: Date the customer joined.
            country:
              type: string
              description: Customer's country.
            city:
              type: string
              description: Customer's city.
            zip:
              type: string
              description: Customer's postal code.
            preferredLanguage:
              type: string
              description: >-
                The customer's preferred language for communication and
                interactions. This is typically used to personalize
                notifications, messages, and other system interactions based on
                the customer's language preference.
            tags:
              type: array
              items:
                type: string
              description: >-
                A list of tags or labels associated with the customer. These
                tags are used to categorize customers for personalized marketing
                campaigns, rewards, and tailored communications.
            source:
              type: string
              description: Source of the customer registration.
            utms:
              type: array
              description: List of UTM attributes associated with the customer.
            utMs:
              type: array
              description: List of UTM attributes associated with the customer.
            devices:
              type: array
              description: List of devices associated with the customer.
            paymentMethods:
              type: array
              items:
                type: string
              description: >-
                List of payment methods used by the customer. This array may
                include various forms of payment, such as credit cards, PayPal,
                or other payment providers. Each payment method is represented
                as a string.
            totalSpent:
              type: number
              description: Total amount spent by the customer.
            lastOrderDate:
              type: string
              description: Date of the last order placed by the customer.
            totalOrders:
              type: number
              description: Total number of orders placed by the customer.
            avgOrderAmount:
              type: number
              description: Average amount spent per order by this customer.
            channel:
              type: string
              description: >-
                Indicates the channel through which the customer was acquired or
                engaged. This is especially useful for systems that support
                multiple channels to track customer origin and interactions.
                Understanding the acquisition or engagement channel helps in
                tailoring marketing strategies, optimizing communication, and
                analyzing customer preferences.
              enum:
                - mobile
                - pos
                - web
                - callcenter
            custom:
              type: object
              additionalProperties: true
              description: >-
                Key-value pairs that allow you to store additional attributes
                for the customer. This can include any extra information
                specific to your needs, enabling more personalized interactions
                and offerings.
            manualDate:
              type: string
              description: Custom date for manual entries.
        referralCode:
          type: string
          description: The referral code of the customer
        referralLink:
          type: string
          description: The referral link generated for the customer
        isReferred:
          type: boolean
          description: Boolean indicating if this customer was referred
        dynamicReferralLink:
          type: string
          description: Dynamic referral link for mobile apps
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````