# Get details of a specific reward

By specifying a unique reward ID, this endpoint provides detailed information about a particular reward. This includes attributes like name, type, status, and redemption data. Businesses can use this information to display or manage specific rewards within their applications, ensuring members have access to the most relevant details.

Endpoint: GET /rewards/{{reward_id}}
Version: 3.0.0
Security: 

## Path parameters:

  - `reward_id` (string, required)
    Unique identifier of the reward.

## Response 200 fields (application/json):

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

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

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

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

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

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

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

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

  - `reward_sequence` (integer)
    Displays the reward's position in the display order on the dashboard.
    Example: 1

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

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

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

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

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

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

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

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

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

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

  - `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/14/2025 00:00:00"

  - `reward_eligibility` (object)
    Displays the eligibility rules members must meet for the reward to be issued.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `code_expiration` (string)
    Displays the duration after which the code expires in ISO 8601 format
    Example: "P60D"

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

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

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

  - `redemption_data` (object)
    Displays the fields required for reward redemption.

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

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

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

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

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

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

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

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

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

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

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

  - `metadata` (object)
    Displays metadata about the reward.

  - `metadata.create_date` (string)
    Displays the date when the reward was created in the system, formatted as MM/DD/YYYY HH:mm:ss
    Example: "01/31/2025 23:59:59"

  - `metadata.update_date` (string)
    Displays the date when the reward was last updated in the system, formatted as MM/DD/YYYY HH:mm:ss
    Example: "01/31/2025 23:59:59"