Rewards API#


This API will be deprecated in the near future. Please use the reward section in the Display API for future projects.

The Rewards API can be used to query information about rewards (vouchers & coupons, downloadable rewards, virtual rewards, custom rewards) available in the loyalty program.

In order to use the Rewards API, you need to obtain an API key from the platform. Please refer to the Events API documentation for more information on how to do so.

Listing available rewards#

A GET request to the Rewards endpoint results in a paginated list that including every available reward in JSON format. The base url of the request depends on the environment used and please consult with your Customer Success Representative about the base API url.

All server to server calls should follow the API security protocol and signing procedure and be aware of the API rate limits.

The OpenApi yaml file used to generate this documentation can be downloaded here