Skip to main content
Retrieves a paginated list of active loyalty rewards available in your organisation’s reward catalogue. Results are sorted by created_at in descending order. GET /public/rewards

Authorizations

Authorization string header required Bearer authentication header of the form Bearer <token>, where <token> is your REST API token.

Query Parameters

reward_type enum<string> Filter results to only rewards of the given type. Available options: fixed_discount, percentage_discount, free_shipping, free_product, store_credit per_page integer default: 20 The number of results per page. Required range: 1 <= x <= 100 page integer default: 1 The page number to retrieve.

Response

200 - application/json data object[] Hide child attributes data.id string<uuid> Unique UUID identifier for the reward. Example: "90424fa7-e8a9-4ef4-b43a-72c9b2028db5" data.name string The display name of the reward. Example: "$5 off your next order" data.description string | null A description of the reward shown to customers. Example: "Redeem 500 points for a $5 discount." data.reward_type enum<string> The type of reward issued to the customer. Available options: fixed_discount, percentage_discount, free_shipping, free_product, store_credit Example: "fixed_discount" data.points_cost integer The number of points required to redeem this reward. Example: 500 data.reward_rule object The rule configuration for this reward. Structure varies by reward_type. Example: { "points_required": 500, "discount_value": 5 } data.is_active boolean Whether this reward is currently active and available for redemption. Example: true data.created_at string<date-time> Example: "2025-12-01T09:00:00.000Z" data.updated_at string<date-time> Example: "2025-12-01T09:00:00.000Z" meta object Hide child attributes meta.pagination object Hide child attributes meta.pagination.current_page integer Example: 1 meta.pagination.per_page integer Example: 20 meta.pagination.total integer Example: 3 meta.pagination.last_page integer Example: 1 meta.pagination.has_more boolean Example: false
curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/rewards?reward_type=fixed_discount" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
{
  "data": [
    {
      "id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
      "name": "$5 off your next order",
      "description": "Redeem 500 points for a $5 discount.",
      "reward_type": "fixed_discount",
      "points_cost": 500,
      "reward_rule": {
        "points_required": 500,
        "discount_value": 5
      },
      "is_active": true,
      "created_at": "2025-12-01T09:00:00.000Z",
      "updated_at": "2025-12-01T09:00:00.000Z"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "10% off your next order",
      "description": "Redeem 1000 points for 10% off.",
      "reward_type": "percentage_discount",
      "points_cost": 1000,
      "reward_rule": {
        "points_required": 1000,
        "discount_percentage": 10
      },
      "is_active": true,
      "created_at": "2025-12-01T09:00:00.000Z",
      "updated_at": "2025-12-01T09:00:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 2,
      "last_page": 1,
      "has_more": false
    }
  }
}