curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/rewards?reward_type=fixed" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const params = new URLSearchParams({ reward_type: "fixed" });
const response = await fetch(
`https://api.yukoapp.com/api/v1/public/rewards?${params}`,
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$query = http_build_query(["reward_type" => "fixed"]);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/rewards?{$query}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
"name": "$5 off your next order",
"description": "Redeem 500 points for a $5 discount.",
"reward_type": "fixed",
"points_cost": 500,
"reward_rule": {
"points_required": 500,
"value": 5
},
"icon": null,
"is_active": true,
"created_at": "2025-12-01T09:00:00+00:00",
"updated_at": "2025-12-01T09:00:00+00:00"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "10% off your next order",
"description": "Redeem 1000 points for 10% off.",
"reward_type": "percentage",
"points_cost": 1000,
"reward_rule": {
"points_required": 1000,
"value": 10
},
"icon": null,
"is_active": true,
"created_at": "2025-12-01T09:00:00+00:00",
"updated_at": "2025-12-01T09:00:00+00:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 2,
"last_page": 1,
"has_more": false
}
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Rewards
List rewards
Retrieves a paginated list of active loyalty rewards in your reward catalogue.
GET
/
public
/
rewards
curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/rewards?reward_type=fixed" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const params = new URLSearchParams({ reward_type: "fixed" });
const response = await fetch(
`https://api.yukoapp.com/api/v1/public/rewards?${params}`,
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$query = http_build_query(["reward_type" => "fixed"]);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/rewards?{$query}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
"name": "$5 off your next order",
"description": "Redeem 500 points for a $5 discount.",
"reward_type": "fixed",
"points_cost": 500,
"reward_rule": {
"points_required": 500,
"value": 5
},
"icon": null,
"is_active": true,
"created_at": "2025-12-01T09:00:00+00:00",
"updated_at": "2025-12-01T09:00:00+00:00"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "10% off your next order",
"description": "Redeem 1000 points for 10% off.",
"reward_type": "percentage",
"points_cost": 1000,
"reward_rule": {
"points_required": 1000,
"value": 10
},
"icon": null,
"is_active": true,
"created_at": "2025-12-01T09:00:00+00:00",
"updated_at": "2025-12-01T09:00:00+00:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 2,
"last_page": 1,
"has_more": false
}
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Shopify POS rewards aren’t included. Results are sorted by
created_at, newest first. To fetch a single reward, use Retrieve a reward.
Requires the
read:rewards scope. See Scopes.Query parameters
enum<string>
Return only rewards of this type. One of
fixed, percentage, free_shipping, free_product, store_credit.integer
default:20
The number of results per page, from
1 to 100. Values above 100 are treated as 100.integer
default:1
The page number to retrieve. See Classic pagination.
Response
object[]
The rewards on this page.
Show reward properties
Show reward properties
string<uuid>
Unique identifier for the reward.
string
The display name of the reward.
string | null
A description of the reward shown to customers.
enum<string>
The type of reward issued to the customer. One of
fixed, percentage, free_shipping, free_product, store_credit.integer
The number of points required to redeem this reward.
object
The rule configuration for this reward. Structure varies by
reward_type.object | null
The reward’s storefront icon, or
null if none is set. Contains source (default or custom), slug, id and url. See Retrieve a reward for details.boolean
Whether this reward is currently active and available for redemption.
string<date-time>
When the reward was created.
string<date-time>
When the reward was last updated.
object
Errors
| Status | Code | When |
|---|---|---|
401 | missing_token, invalid_token | The API key is missing, wrong or revoked. |
403 | insufficient_scope | The key doesn’t have read:rewards. |
429 | The key exceeded the rate limit. |
curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/rewards?reward_type=fixed" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const params = new URLSearchParams({ reward_type: "fixed" });
const response = await fetch(
`https://api.yukoapp.com/api/v1/public/rewards?${params}`,
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$query = http_build_query(["reward_type" => "fixed"]);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/rewards?{$query}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
"name": "$5 off your next order",
"description": "Redeem 500 points for a $5 discount.",
"reward_type": "fixed",
"points_cost": 500,
"reward_rule": {
"points_required": 500,
"value": 5
},
"icon": null,
"is_active": true,
"created_at": "2025-12-01T09:00:00+00:00",
"updated_at": "2025-12-01T09:00:00+00:00"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "10% off your next order",
"description": "Redeem 1000 points for 10% off.",
"reward_type": "percentage",
"points_cost": 1000,
"reward_rule": {
"points_required": 1000,
"value": 10
},
"icon": null,
"is_active": true,
"created_at": "2025-12-01T09:00:00+00:00",
"updated_at": "2025-12-01T09:00:00+00:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 2,
"last_page": 1,
"has_more": false
}
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}