Points Actions
Points Actions

Knowledge Base

Use this API route to get all the methods to earn points in a points and rewards system. It requires only the general reading permission.


Available parameters

  • Id : Description
  • pool_id : (string) – The points and rewards system identifier.


The JSON response is an array of earning method objects. Each object contains at least the following properties:

  • Id : Description
  • id : The method identifier to use for future references.
  • gain : The amount of points added when the method is triggered.
  • title : The public method title.
  • description : The custom method description (if any set by the administrator).

Error cases

A 404 error is raised if the points and rewards system identifier cannot be found.

Was this article helpful?
Dislike 0
Views: 260

Continue reading

Previous: Points and Rewards Systems Info
Next: Rewards