Skip to content

Documentation

WooRewards

  1. Home
  2. Docs
  3. WooRewards
  4. API
  5. Rewards

Rewards

 

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

 

GET
wp-json/woorewards/v1/pools/<pool_id>/rewards

 

Available parameters

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

Response

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

  • id : The reward identifier to use for future references.
  • cost : The amount of point required (and consumed) to purchase the reward.
  • title : The public reward title.
  • description : The plain text reward description.

Error cases

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

Was this article helpful to you? Yes No
Scroll To Top