# Retrieve list of eligible rewards for a member

This endpoint retrieves a list of rewards associated with a specific user, identified by the member ID. The response includes reward details, eligibility information, and pagination metadata. This endpoint checks and retrieves the eligibility status of rewards for a specific member, identified by their member ID. It determines whether the member qualifies for any available rewards based on predefined criteria such as past transactions, membership status, or other eligibility rules If no rewards are available, the response will indicate ineligibility.

Endpoint: GET /users/{{member_id}}/rewards
Version: 3.0.0
Security: 

## Path parameters:

  - `member_id` (string, required)
    Unique identifier of the member whose rewards are being requested.

## Response 200 fields (application/json):

  - `rewards` (array)
    Displays an array of reward objects, each containing detailed information about individual rewards.

  - `rewards.reward_id` (string)
    Displays the unique identifier assigned to the reward.
    Example: "Reward1"

  - `rewards.reward_name` (string)
    Displays the name of the reward. This is a descriptive label for identifying the reward.
    Example: "Test Reward 5"

  - `rewards.reward_type` (string)
    Displays the reward type. This is typically used to categorize the reward.
    Example: "Reward"

  - `rewards.reward_status` (string)
    Displays the current status of the reward, indicating its lifecycle stage such as Draft, Scheduled, Live or Archived.
    Example: "Live"

  - `rewards.reward_category_id` (string)
    Displays the unique identifier for the reward’s category.
    Example: "543"

  - `rewards.reward_category_name` (string)
    Displays the name of the reward’s category.
    Example: "Sports Shoes"

  - `rewards.reward_description` (string)
    Displays the description of the reward, if provided.
    Example: "Get a $10 discount on your next purchase when you spend $50 or more."

  - `rewards.reward_terms` (string)
    Displays the terms and conditions associated with the reward.
    Example: "Cannot be combined with other offers or discounts."

  - `rewards.reward_images` (object)
    Displays image-related metadata associated with an reward.

  - `rewards.reward_images.url` (string)
    Displays the URL of the image associated with the Reward.
    Example: "https://cdn.example.com/rewards/.png"

  - `rewards.reward_images.type` (string)
    Displays the type or style of the image used for the Reward (such as logo5, thumbnail, or other custom labels).
    Example: "Logo4"

  - `rewards.reward_images.height` (string)
    Displays the height of the reward image in pixels.
    Example: "150"

  - `rewards.reward_images.width` (string)
    Displays the width of the reward image in pixels.
    Example: "150"

  - `rewards.reward_images.background_color` (string)
    Displays the background color of the image in a hexadecimal code.
    Example: "#ffffffff"

  - `rewards.availability_period` (object)
    Displays the time frame during which the reward is available.

  - `rewards.availability_period.specific_year` (integer)
    Displays the year for which the reward is available.
    Example: 2025

  - `rewards.availability_period.specific_period` (string)
    Displays the availability type, such as Dates, Monthly, Quarterly and Yearly. NOTE – specific_period_details, (conditionally displayed) - Displays relevant details (e.g., monthly, quarterly) if specific_period is not set to Dates.
    Example: "Dates"

  - `rewards.availability_period.start_date` (string)
    Displays the starting date and time of availability in MM/DD/YYYY HH:mm:ss format. NOTE - Displayed conditionally based on specific_period selected.
    Example: "01/14/2025 00:00:00"

  - `rewards.availability_period.end_date` (string)
    Displays the ending date and time of availability in MM/DD/YYYY HH:mm:ss format. NOTE - Displayed conditionally based on specific_period selected.
    Example: "01/31/2025 23:59:59"

  - `rewards.reward_eligibility` (object)
    Displays the eligibility rules members must meet to redeem the reward.

  - `rewards.reward_eligibility.debit_points` (integer)
    Displays the number of points required for the reward to be issued.

  - `rewards.reward_eligibility.eligibility_based_on` (string)
    Displays the condition for reward eligibility (e.g., Tier, Purchase Amount, or Lifetime Points).
    Example: "Tier"

  - `rewards.reward_eligibility.tier_data` (object)
    Displays additional details if the eligibility is based on tiers.

  - `rewards.reward_eligibility.tier_data.tier_id` (string)
    Displays the ID of the eligible tier.
    Example: "2719"

  - `rewards.reward_eligibility.tier_data.tier_name` (string)
    Displays the name of the eligible tier.
    Example: "Elite"

  - `rewards.member_data` (object)
    Displays personalized reward information for the logged-in member.

  - `rewards.member_data.member_reward_status` (string)
    Displays whether the reward is currently Available or Unavailable for the member. NOTE - Available - Member is eligible to earn this reward and Unavailable - Member is not eligible to earn this reward.
    Example: "Available"

  - `rewards.member_data.unavailability_reason` (string)
    Displays the reason why the reward is unavailable, if applicable.
    Example: "Reward unavailable due to insufficient points balance."

  - `rewards.member_data.points_short` (integer)
    Displays the number of additional points the member needs to become eligible.
    Example: 20

  - `rewards.member_data.reward_issued_count` (integer)
    Displays the number of times the reward has been issued to the member.

  - `rewards.member_data.balance_issuance` (integer)
    Displays the remaining number of times the reward can be issued to the member.
    Example: 2

  - `rewards.issuance_details` (object)
    Displays reward issuance configuration and module associations.

  - `rewards.issuance_details.auto_issuance` (object)
    Displays details about auto issuance.

  - `rewards.issuance_details.auto_issuance.auto_issue` (string)
    Displays whether the reward is set for automatic issuance. NOTE - This can be based on either Automate Reward or Time-Based Issuance configured in the ADR. Both criteria cannot be applied simultaneously.
    Example: "Yes"

  - `rewards.issuance_details.auto_issuance.condition` (string)
    Displays the condition used to trigger auto issuance. They possible values are Lifetime Points, Purchase Amount and Available Points
    Example: "Available Points"

  - `rewards.issuance_details.auto_issuance.threshold_type` (string)
    Displays whether the threshold type is based on a fixed or rolling window. Note - Select Fixed if the reward should be issued to a member only once. Choose Rolling if the reward should be issued multiple times whenever the member meets the eligibility criteria.
    Example: "Yes"

  - `rewards.issuance_details.auto_issuance.threshold_value` (string)
    Displays the numeric threshold value that must be met to trigger reward issuance.
    Example: 100

  - `rewards.issuance_details.auto_issuance.limit_per_issuance` (integer)
    Displays the maximum number of times the reward can be automatically issued to a member for a transaction.

  - `rewards.issuance_details.auto_issuance.auto_issuance_reason` (string)
    Displays the reason or context for the automatic reward issuance, if configured.
    Example: "Milestone Achieved"

  - `rewards.issuance_details.auto_issuance.auto_issue_date` (string)
    Displays the fixed issuance date, if configured in YYYY-MM-YY format.
    Example: "2025-05-25"

  - `rewards.benefit_details` (object)
    Displays the benefit details associated with the reward.

  - `rewards.benefit_details.discount_amount` (string)
    Displays the discount value offered by the reward.
    Example: "10.00"

  - `rewards.benefit_details.currency` (string)
    Displays the currency symbol used with the discount.
    Example: "$"

  - `rewards.benefit_details.products` (array)
    Displays a list of product IDs the reward applies to.
    Example: ["P1","P2"]

  - `rewards.reward_attributes` (object)
    Displays details about the extended attributes.

  - `rewards.reward_attributes.key` (string)
    Displays the name of the attribute.
    Example: "VAT"

  - `rewards.reward_attributes.value` (string)
    Displays the value associated with the attribute.
    Example: "10"

  - `rewards.redemption_data` (object)
    Displays the fields required for reward redemption, including their names and data types.

  - `rewards.redemption_data.field_name` (string)
    Displays the name of the field needed for redemption.
    Example: "City"

  - `rewards.redemption_data.data_type` (string)
    Displays the expected data type of the field.
    Example: "VARCHAR"

  - `rewards.member_reward_limit` (integer)
    Displays the limit on how many times the reward can be issued to the member.
    Example: 2

  - `rewards.limit_period` (string)
    Displays the time window for the member limit.
    Example: "Anniversary Year"

  - `rewards.overall_reward_limit` (integer)
    Displays the total number of times this reward can be issued across all members.
    Example: 1000

  - `rewards.overall_reward_issued` (integer)
    Displays the number of times the reward has already been issued.
    Example: 8

  - `rewards.reward_issuance_balance` (integer)
    Displays the remaining quantity of the reward that can be issued.
    Example: 992

  - `rewards.reward_expiration_period` (string)
    Displays the duration after which the reward expires.
    Example: "120 Days"

  - `metadata` (object)
    Displays pagination details for the list of rewards.

  - `metadata.current_page` (integer)
    Displays the current page number of the results.
    Example: 1

  - `metadata.page_size` (integer)
    Displays the number of rewards returned per page.
    Example: 20

  - `metadata.total_pages` (integer)
    Displays the total number of pages available.
    Example: 1

  - `metadata.total_rewards` (integer)
    Displays the total number of rewards available across all pages.
    Example: 5