---
title: "List Member's Eligible Rewards API"
method: GET
path: "/eligible-rewards"
---

# List Member's Eligible Rewards API

`GET /eligible-rewards`

## Query parameters

- `start_cursor` integer
- `count` integer
- `language` string
- `ignore_allowed_redeem_points` boolean
- `sort_by` string

## Response `200`

200

- EligibleRewardsResponseObject
  - `total` integer — The total number of eligible rewards.
  - `next_cursor` integer — This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.
  - `more` boolean
  - `rewards` EligibleRewardsRewardObject
    - `reward_name` string — The reward name stored with Zinrelo.
    - `enduser_reward_confirmation_html` string — "Redemption Confirmation Text" configuration in Zinrelo admin console.
    - `reward_card_background_image_url` string — "Reward Tile Image" configuration in Zinrelo admin console.
    - `implementation_type` string — By default, all our rewards are coupon-based. However, we also support add-to-cart rewards.
    - `reward_value` string — The reward value configured in Zinrelo.
    - `last_modified_date` string — The recent date and time on which the reward configuration was updated.
    - `reward_sub_type` string — These are the reward types we offer: Fixed amount discount, Free shipping, Product redemption, and Percentage discount.
    - `created_date` string — The date and time on which the reward was created.
    - `enduser_reward_short_description` string — "End User Reward Description" configuration in Zinrelo admin console.
    - `points_to_be_redeemed` integer — The points to be deducted when the reward is redeemed.
    - `reward_type` string — All our rewards are coupon-based.
    - `enduser_reward_post_confirmation_html` string — "Post Redemption HTML" configuration in Zinrelo admin console.
    - `id` string — The internal ID generated by Zinrelo.
    - `reward_id` string — The unique ID of the reward assigned by Zinrelo.
    - `metadata` object — The metadata associated with the reward.
      - `Category` string
      - `Brand` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/trueloyal/apis/admin-apis.md) · [All operations](https://skmtc.net/trueloyal/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trueloyal/admin-apis/versions/c12d3d379897/schema)