Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
Get Customer
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId} \
  --header 'apikey: <api-key>'
{
  "gameballId": 123,
  "customerId": "<string>",
  "customerAttributes": {
    "gender": "<string>",
    "country": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "custom": {},
    "tags": [
      "<string>"
    ],
    "source": "<string>",
    "utMs": "<array>",
    "utms": "<array>",
    "devices": "<array>",
    "paymentMethods": [
      "<string>"
    ],
    "totalSpent": 123,
    "lastOrderDate": "<string>",
    "totalOrders": 123,
    "manualDate": "<string>"
  },
  "referralCode": "<string>",
  "referralLink": "<string>",
  "isReferred": true,
  "dynamicReferralLink": "<string>"
}
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.
This endpoint returns general customer info (no personal data) with the public key. To access PII, use Get Customer Details with the secret key.
Security: Requires apiKey header.

Authorizations

​
apikey
string
header
required

Path Parameters

​
customerId
string
required

Unique identifier for the customer

Response

200 - application/json

Customer found

​
gameballId
number

The customer's unique ID within the Gameball system

​
customerId
string

Unique identifier for the customer

​
customerAttributes
object

Customer attributes (minimized, excluding PII)

​
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