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

> Retrieve essential customer information from Gameball using a unique customerId.

This API allows you to retrieve essential customer information from Gameball using a unique `customerId`. While focused on providing key profile details, the response excludes personally identifiable information (PII), ensuring secure access to customer data for seamless integration and personalized engagement.

<Info>
  This endpoint returns general customer info (no personal data) with the public key. To access PII, use [Get Customer Details](/api-reference/customers/management/get-customer-details) with the secret key.
</Info>

<Info>
  **Security**: Requires **apiKey** header.
</Info>


## OpenAPI

````yaml GET /api/v4.0/integrations/customers/{customerId}
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}:
    get:
      summary: Get Customer
      description: >-
        Retrieve essential customer information from Gameball using a unique
        customerId. Returns general customer info (no personal data) with the
        public key.
      operationId: getCustomer
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier for the customer
      responses:
        '200':
          description: Customer found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponse'
      security:
        - apiKey: []
components:
  schemas:
    CustomerResponse:
      type: object
      properties:
        gameballId:
          type: number
          description: The customer's unique ID within the Gameball system
        customerId:
          type: string
          description: Unique identifier for the customer
        customerAttributes:
          type: object
          description: Customer attributes (minimized, excluding PII)
          properties:
            gender:
              type: string
              description: Customer's gender.
            country:
              type: string
              description: Customer's country.
            city:
              type: string
              description: Customer's city.
            zip:
              type: string
              description: Customer's postal code.
            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.
            tags:
              type: array
              items:
                type: string
              description: Tags associated with the customer.
            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.
            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.
            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

````