API Reference

Learn more about our available endpoints at Gameball needed during integration.

The API base URL is below with v3.0 as our current version.

https://api.gameball.co/api/{version}

The REST API is organized around the following endpoints:

API Area

Resource Area

Description

Player

/integrations/player

The player API is responsible for creating new players at Gameball as well as updating players' data at Gameball.

Event

/integrations/event

The event API is used to submit user events to Gameball.

Transactions

/integrations/transaction

The transactions APIs are responsible for all the player's points transactions.

Order

/integrations/order

The Order API is used to track a new order. This endpoint is designed specifically for E-Commerce Solutions.

Action

/integrations/action

The Action API endpoint is used to send player event(s), completing cashback and redeeming points in a single API call.

Leaderboard

/integrations/leaderboard

This endpoint allows you to retrieve the players' leaderboard for a given date range. It can also be used to get a specific player's rank among all players.

Notifications

/integrations/notifications

The Notifications API can be used to list the player's notifications and also to update its status once read.

Configurations

/integrations/configurations

This endpoint allows you to retrieve your configured settings on Gameball account which can be used while creating your custom UI for the player profile on your website or mobile app.

Batches

/integrations/batch

Batch operations are used to make multiple one type operations with one request.

Next, check each section to learn more about how to use each API area.