---
title: "Get Customer Details"
method: GET
path: "/api/v4.0/integrations/customers/{customerId}/details"
---

# Get Customer Details

`GET /api/v4.0/integrations/customers/{customerId}/details`

Retrieve comprehensive customer information including personally identifiable information (PII).

## Path parameters

- `customerId` string, required

## Response `200`

Customer details found

- CustomerDetailsResponse
  - `customerId` string — Unique identifier for the customer
  - `gameballId` number — The customer's unique ID within the Gameball system
  - `customerAttributes` object — Complete customer attributes including PII
    - `displayName` string — Display name for the customer.
    - `firstName` string — Customer's first name.
    - `lastName` string — Customer's last name.
    - `email` string — Customer's email address.
    - `gender` string — Customer's gender.
    - `mobile` string — Customer's mobile number.
    - `dateOfBirth` string — Customer's date of birth.
    - `joinDate` string — Date the customer joined.
    - `country` string — Customer's country.
    - `city` string — Customer's city.
    - `zip` string — Customer's postal code.
    - `preferredLanguage` string — 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` string[] — 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` string — Source of the customer registration.
    - `utms` unknown[] — List of UTM attributes associated with the customer.
      - unknown
    - `utMs` unknown[] — List of UTM attributes associated with the customer.
      - unknown
    - `devices` unknown[] — List of devices associated with the customer.
      - unknown
    - `paymentMethods` string[] — 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` number — Total amount spent by the customer.
    - `lastOrderDate` string — Date of the last order placed by the customer.
    - `totalOrders` number — Total number of orders placed by the customer.
    - `avgOrderAmount` number — Average amount spent per order by this customer.
    - `channel` 'mobile' | 'pos' | 'web' | 'callcenter' — 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.
    - `custom` object — 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` string — Custom date for manual entries.
  - `referralCode` string — The referral code of the customer
  - `referralLink` string — The referral link generated for the customer
  - `isReferred` boolean — Boolean indicating if this customer was referred
  - `dynamicReferralLink` string — Dynamic referral link for mobile apps

---

[API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/revisions/2e4a8bfe2291/schema)
