How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Gameball

Gameball REST API

RESTful loyalty & gamification API for managing customers, events, orders, payments, points transactions, holds, coupons, reward campaigns, VIP tiers, redemption options, leaderboards and batch operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 78 operations across 71 paths, organized into 6 resource areas, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 4.0.0.

Requests are made against a single base URL, https://api.gameball.co.

78 operations 71 paths 44 schemas 7 DELETE35 GET31 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0.0
Base URL
https://api.gameball.co/api/v4.0
Authentication
API Key, API Key, HTTP Bearer
Resource Areas
6

Authentication & Security 3

Gameball REST API declares 3 security schemes for authenticating requests. An API key is passed in the header as apikey (apiKey). An API key is passed in the header as secretkey (secretKey). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 78

Across 71 paths, the API surfaces 78 operations — 7 DELETE, 35 GET, 31 POST, 5 PUT. They span 6 resource areas: Operations, Customers, Payments, Batches, Orders, Events. Each is listed below with its method, path, parameters, and response codes.

Operations 70
POST
/api/v4.0/integrations/customers
Create Customer
createCustomer body → 200
GET
/api/v4.0/integrations/customers/{customerId}
Get Customer
getCustomer 1 param → 200
DELETE
/api/v4.0/integrations/customers/{customerId}
Delete Customer
deleteCustomer 1 param → 200
GET
/api/v4.0/integrations/customers/{customerId}/details
Get Customer Details
getCustomerDetails 1 param → 200
GET
/api/v4.0/integrations/customers/{customerId}/coupons
Get Customer Coupons
getCustomerCoupons 1 param → 200
POST
/api/v4.0/integrations/customers/social-challenges
Achieve Social Campaign
achieveSocialChallenge body → 202400401404500
GET
/api/v4.0/integrations/customers/{customerId}/hash
Get Customer Hash
getCustomerHash 1 param → 200
GET
/api/v4.0/integrations/referrals/validate
Validate Referrer Code
validateReferrerCode 2 params → 200
POST
/api/v4.0/integrations/payments
The API call tracks new payments, specifically tailored for fintech solutions. It captures key payment details, ensuring accurate tracking of customer transactions. This API triggers the "Payment Pro…
body → 200
POST
/api/v4.0/integrations/transactions/redeem
This API enables customers to redeem loyalty points as a payment method in Gameball, allowing them to use points in place of monetary value during transactions. By providing details such as customerI…
body → 200
POST
/api/v4.0/integrations/transactions/cashback
This API awards loyalty points to customers in Gameball through a cashback program based on the amount.
body → 200
POST
/api/v4.0/integrations/transactions/refund
This API processes refunds or cancellations of cashback and points redemption transactions in Gameball. By providing a reverseTransactionId, Gameball identifies the related cashback or redemption tra…
body → 200
POST
/api/v4.0/integrations/transactions/hold
This API holds loyalty points for a specified duration, reserving them until a redemption request is made through Order or Redeem. If no redemption occurs within the hold period, the points are relea…
body → 200
GET
/api/v4.0/integrations/transactions/hold/{holdReferenceId}
This API retrieves the details of a specific hold in Gameball using holdReferenceId. It returns information on the amount of loyalty points held, their monetary value, the hold's status (active, used…
1 param → 200
DELETE
/api/v4.0/integrations/transactions/hold/{holdReferenceId}
This API cancels a specific hold on loyalty points in Gameball using the provided holdReferenceId. It releases the held points back into the customer's account, enabling flexibility in point manageme…
1 param → 200
GET
/api/v4.0/integrations/transactions
This API retrieves a paged list of transactions from Gameball, allowing for optional filtering. Each transaction record includes details such as type, direction, points, amount, transaction time, and…
5 params → 200
POST
/api/v4.0/integrations/transactions/manual
This API allows for the manual addition or deduction of points for a customer in Gameball. It provides flexibility in managing loyalty points, enabling adjustments based on specific needs or circumst…
body → 200400
GET
/api/v4.0/integrations/transactions/customer-view
This API retrieves a paged list of transactions from Gameball, with support for optional filtering. It provides the same comprehensive transaction data as the previous version — including type, direc…
5 params → 200
GET
/api/v4.0/integrations/transactions/count
This API retrieves the total count of transactions from Gameball, allowing for optional filtering. It provides the number of transactions matching the specified criteria without returning detailed tr…
3 params → 200
PUT
/api/v4.0/integrations/transactions/{transactionId}/activate
This API is used to immediately activate loyalty points that are currently in a pending state, bypassing the configured return window duration. This endpoint overrides that duration and activates the…
1 param → 200
POST
/api/v4.0/integrations/transactions/otp
The API call generates a new one-time password (OTP) for redeeming or holding loyalty points and sends it via SMS. This service ensuring that only authorized transactions can be completed with the pr…
body
POST
/api/v4.0/integrations/coupons/predefined
Create a coupon based on predefined redemption rules.
body → 200
POST
/api/v4.0/integrations/coupons/{code}/validate
This API validates a single coupon identified by {code} and checks its eligibility for use by a customer. It also supports a locking feature, where setting the lock flag to True reserves the coupon b…
1 param body → 200
POST
/api/v4.0/integrations/coupons/validate
This API validates a list of coupons and checks their eligibility for use by a customer. It also supports a locking feature, where setting the lock flag to True reserves eligible coupons by creating…
body → 200
POST
/api/v4.0/integrations/coupons/burn
This API processes the use of one or more coupons associated with a customer in Gameball. By providing customer details and a list of coupons, this endpoint marks the coupons as redeemed, completing…
body → 200
DELETE
/api/v4.0/integrations/coupons/{lockReference}
This API releases the lock on coupons identified by the provided {lockReference} in Gameball. Once released, the coupons become available for use again, offering flexibility in managing coupon availa…
1 param → 200
POST
/api/v4.0/integrations/coupons/automatic
Apply predefined automatic coupons based on specific promotional criteria.
body → 200
GET
/api/v4.0/integrations/configurations/rewards/cashback
Retrieve cashback configuration settings for the loyalty program.
→ 200
GET
/api/v4.0/integrations/configurations/rewards/redemption
Retrieve point redemption configuration settings for the loyalty program.
→ 200
GET
/api/v4.0/integrations/configurations/rewards/coupons
Retrieve coupon system configuration settings for the loyalty program.
→ 200
PUT
/api/v4.0/integrations/configurations/rewards/coupons
Update coupon system configuration settings for the loyalty program.
body → 200
GET
/api/v4.0/integrations/configurations/reward-campaigns
Campaigns Configurations
getCampaignsConfigurations 4 params → 200
GET
/api/v4.0/integrations/configurations/tiers
Tiers Configurations
getTiersConfigurations 1 param → 200
GET
/api/v4.0/integrations/configurations/referrals
Referrals Configurations
getReferralsConfigurations 1 param → 200
GET
/api/v4.0/integrations/configurations/widget
Retrieve styling settings, including colors and other visual elements for the Gameball widget.
→ 200
GET
/api/v4.0/integrations/leaderboard
This API retrieves the leaderboard rankings of customers within your loyalty program in Gameball, either for a specific date range or for all time. Results are ordered from the highest to the lowest…
6 params → 200
GET
/api/v4.0/integrations/configurations/cashback
This API call retrieves your cashback configurations, providing essential details about how cashback rewards are structured and managed in Gameball. If the customerId is provided, the API will return…
1 param → 200
GET
/api/v4.0/integrations/configurations/redemption
This API retrieves the configurations and rules associated with how customers can redeem points for discounts, coupons, or other rewards.
1 param → 200
GET
/api/v4.0/integrations/configurations/coupon
This API call retrieves your coupon configurations, including details about how coupons are structured, authenticated, and mapped within Gameball.
→ 200
PUT
/api/v4.0/integrations/configurations/coupon
This API call updates your coupon configurations, allowing you to modify details about how coupons are structured, authenticated, and mapped within Gameball.
body → 200
POST
/api/v4.0/integrations/batch/customers
Create or update multiple customer profiles in a single API call for bulk user imports and mass profile updates.
body → 200
POST
/api/v4.0/integrations/batch/orders
Register multiple orders for single or multiple customers in a single API call for efficient order management and tracking.
body → 200
POST
/api/v4.0/integrations/batch/balance-inquiry
Retrieve customer loyalty balances for multiple customers in a single API call for efficient balance management.
body → 200
POST
/api/v4.0/integrations/batch/balance-adjustment
Adjust customer loyalty balances for multiple customers in a single API call for efficient balance management.
body → 200
POST
/api/v4.0/integrations/batch/cashback
Award loyalty points to customers through cashback program for multiple customers in a single API call.
body → 200
POST
/api/v4.0/integrations/batch/redeem
Enable customers to redeem loyalty points as a payment method for multiple customers in a single API call.
body → 200
POST
/api/v4.0/integrations/batch/events
Track multiple user actions or multiple actions for a single user in a single API call for efficient event tracking and analytics.
body → 200
GET
/api/v4.0/integrations/batches/{batchId}/status
Monitor batch job status and results for ongoing batch operations.
1 param → 200
POST
/api/v4.0/integrations/batches/{batchId}/stop
Stop ongoing batch operations when needed.
1 param → 200
DELETE
/api/v4.0/integrations/orders/{orderId}/transactions
Delete a customer by customerId.
1 param
GET
/api/v4.0/integrations/customers/{customerId}/balance
Get Customer Balance
getCustomerBalance 2 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/tier-progress
Get Customer Tier Progress
getCustomerTierProgress 3 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/reward-campaigns-progress
Get Customer Campaigns Progress
getCustomerCampaignsProgress 4 params → 200400422
GET
/api/v4.0/integrations/customers/{customerId}/referrals
Get Customer Referrals
getCustomerReferrals 3 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/referrals/count
Get Customer Referrals Count
getCustomerReferralsCount 1 param → 200
GET
/api/v4.0/integrations/customers/{customerId}/activities
Get Customer Activities
getCustomerActivities 4 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/activities/count
Get Customer Activities Count
getCustomerActivitiesCount 2 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/automation
Get Customer Automation Campaigns
getCustomerAutomationCampaigns 2 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/stamps/{challengeId}
Get Customer Stamps Progress
getCustomerStampsProgress 2 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/streaks/{campaignId}
Get Customer Daily Streak Progress
getCustomerDailyStreakProgress 2 params → 200401404
POST
/api/v4.0/integrations/customers/{customerId}/tags
Attach Customer Tags
attachCustomerTags 1 param body → 200
DELETE
/api/v4.0/integrations/customers/{customerId}/tags
Remove Customer Tags
removeCustomerTags 1 param body → 200
DELETE
/api/v4.0/integrations/customers/{customerId}/tags/{tag}
Remove a tag from a customer.
removeCustomerTag 2 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/notifications
Get Customer Notifications
listCustomerNotifications 5 params → 200
GET
/api/v4.0/integrations/customers/{customerId}/notifications/count
Get Customer Notifications Count
getCustomerNotificationsCount 3 params → 200
PUT
/api/v4.0/integrations/customers/{customerId}/notifications/read
Mark Customer Notifications as Read
markNotificationsRead 1 param body → 200
POST
/api/v4.0/integrations/events
Send Events
sendEvents body → 200
GET
/plants
Returns all plants from the system that the user has access to
1 param → 200
POST
/plants
Creates a new plant in the store
body → 200
DELETE
/plants/{id}
Deletes a single plant based on the ID supplied
1 param
Customers 1
PUT
/api/v4.0/integrations/customers/{customerId}/activate
Update Customer Activation
updateCustomerActivation 1 param body → 200400401404
Payments 1
POST
/api/v4.0/integrations/payments/cashback
Calculate Payment Cashback
calculatePaymentCashback body → 200400401500
Batches 1
POST
/api/v4.0/integrations/batch/orders/transactions
Order Transactions Batch Job
batchOrderTransactions body → 200
Orders 4
POST
/api/v4.0/integrations/orders
Track Order
trackOrder body → 200
POST
/api/v4.0/integrations/orders/cashback
Calculate Order Cashback
calculateOrderCashback body → 200
POST
/api/v4.0/integrations/orders/reward-preview
Preview Order Rewards
previewOrderRewards 1 param body → 200400401
GET
/api/v4.0/integrations/orders/{orderId}/transactions
Order Transactions
getOrderTransactions 1 param → 200
Events 1
POST
/api/v4.0/integrations/events/reward-preview
Preview Event Rewards
previewEventRewards 1 param body → 200400401404

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Coupon (15 properties), RewardCampaignConfiguration (13 properties), RewardPreviewCampaign (12 properties), CustomerBalanceResponse (12 properties). Each schema is shown below with its type and property counts.

UpsertCustomerRequest
object
8 properties 1 required
Customer
object
4 properties
CustomerDetails
object
3 properties
Coupon
object
15 properties
CustomerCoupons
object
1 property
CustomerHash
object
1 property
ReferralValidation
object
1 property
CustomerProgress
object
4 properties
CustomerBalanceResponse
object
12 properties
TierState
object
4 properties
CustomerTierProgressResponse
object
3 properties
CustomerTags
object
3 properties
AttachTagsRequest
object
1 property 1 required
CustomerNotifications
object
2 properties
MarkNotificationsReadRequest
object
1 property 1 required
EventRequest
object
2 properties 2 required
RewardPreviewProgress
object
Present only for ProgressOnly — accumulative / multi-step campaigns the event advances without completing.
4 properties
RewardPreviewCampaign
object
12 properties
RewardPreviewEventResult
object
5 properties
EventRewardPreviewResponse
object
3 properties
OrderRewardPreviewResponse
object
6 properties
Success
object
2 properties
Plant
object
2 properties 1 required
NewPlant
Error
object
2 properties 2 required
CustomerResponse
object
7 properties
CustomerDetailsResponse
object
7 properties
CustomerCouponsResponse
object
1 property
CustomerHashResponse
object
1 property
ReferralValidationResponse
object
1 property
UpsertCustomerResponse
object
1 property
CustomerCampaignsProgressResponse
array
CustomerReferralsResponse
object
3 properties
CustomerReferralsCountResponse
object
3 properties
CustomerActivitiesResponse
object
3 properties
CustomerActivitiesCountResponse
object
1 property
CustomerAutomationCampaignsResponse
object
2 properties
CustomerActionStreakProgressResponse
object
7 properties
CustomerDailyStreakProgressResponse
object
8 properties
CustomerTagsUpdateRequest
object
1 property 1 required
CustomerNotificationsCountResponse
object
1 property
RewardCampaignConfiguration
object
13 properties
TierConfiguration
object
5 properties
ReferralConfiguration
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gameball-openapi.json Raw ↑
← Back to G APIs
API Details
ID
gameball:gameball-rest-api
Base URL
https://api.gameball.co/api/v4.0
Docs
https://docs.gameball.co/api-reference/introduction
Provider
Gameball
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gameball-gameball-rest-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gameball-gameball-rest-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Gameball REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.