Skip to main content

​
Gameball API Overview

The Gameball API gives you everything you need to integrate our loyalty and engagement platform into your system.
It enables you to:
  • Manage customer interactions
  • Track transactions
  • Configure and deliver rewards
With Gameball, you can create a seamless and engaging experience for your users.

​
Why Gameball API?

  • RESTful Design
    Built around REST principles with resource-oriented URLs.
  • Easy Integration
    Uses JSON-encoded responses and standard HTTP methods.
  • Secure & Reliable
    Implements standard HTTP status codes and authentication methods.

​
What You’ll Find in This Section

This section includes a comprehensive API reference covering all endpoints required to integrate with Gameball. With these APIs, you can:
  • Build tailored loyalty experiences
  • Track and log user events
  • Manage customer data
  • Handle transactions
  • And much more!
Whether you’re running an e-commerce store, a fintech platform, or any other customer-facing product, Gameball’s APIs provide the tools you need to boost engagement and drive loyalty.

Current API Version

v4.0 - Latest stable release with enhanced features and improved performance

Supported Platforms

Web, iOS, Android, React Native, Flutter, and Generic mobile apps

​
Authentication

Before making any requests, it’s important to understand how Gameball authenticates incoming API calls.
Refer to the Authentication section for detailed instructions.

​
API Reference

Gameball offers a wide range of endpoints that enable you to interact with and leverage the full power of the Gameball engine. The supported endpoints include:

Customer Management

Manage customer profiles, progress tracking, tags, and notifications

Event Tracking

Track user events and interactions for engagement analytics

Order Processing

Handle order tracking, rewards, and transaction history

Transaction Management

Process cashback, redemptions, holds, and transaction validation

Coupon System

Generate, validate, and manage promotional coupons

Configuration

Configure rewards, programs, and widget settings

Leaderboard

Create and manage customer leaderboards and rankings

​
Base URL

The API base URL is the following, with v4.0 as our current version. 
https://api.gameball.co/api/{version}

​
Webhooks

Use webhooks to automate your workflows and enhance productivity by triggering custom actions based on Gameball events.
More details can be found in the Webhooks section.

​
Errors

To help you troubleshoot any issues, refer to the Errors section to learn about common error codes and their descriptions.