# Retrieve a list of all rewards

This endpoint retrieves a list of all available rewards. It allows businesses to filter rewards based on various parameters such as type, status, and issuance source type. The response includes metadata about the rewards, such as pagination information and total counts, making it easier for applications to manage large datasets.

Endpoint: GET /rewards
Version: 3.0.0
Security: 

## Response 200 fields (application/json):

  - `rewards` (array)
    Displays an array of reward objects, each containing necessary 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: "External Reward"

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

  - `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_sequence` (integer)
    Displays the reward's position in the display order on the dashboard.
    Example: 1

  - `rewards.reward_images` (object)
    Displays image-related metadata associated with a 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 for the reward to be issued.

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

  - `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.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.

  - `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"

  - `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