Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
stamps
/
{challengeId}
Get Customer Stamps Progress
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/stamps/{challengeId} \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "numberOfCompletedSteps": 123,
  "numberOfTimesEarned": 123,
  "canAchieveAgain": true,
  "remainingTries": 123,
  "challengeEndDate": "<string>",
  "rewardName": "<string>",
  "couponName": "<string>"
}
This API retrieves the progress of a specific customer within a particular Stamps campaign in Gameball. It returns how many steps the customer has completed, how many times they’ve earned the campaign reward, and whether they are eligible to continue.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

Path Parameters

​
customerId
string
required

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.

​
challengeId
integer
required

Unique identifier of the Stamps campaign to retrieve progress for.

Response

200 - application/json

Customer stamps progress found

​
numberOfCompletedSteps
number

The number of steps completed by the customer in the current challenge cycle

​
numberOfTimesEarned
number

The total number of times the customer has successfully completed the challenge

​
canAchieveAgain
boolean

Whether the customer is currently eligible to continue the challenge

​
remainingTries
number

The number of remaining allowed completions within the current time interval

​
challengeEndDate
string

The end date of the challenge in the client's local timezone

​
rewardName
string

The name of the reward as defined in the client's configured language

​
couponName
string

The name or value of the discount coupon assigned