# Retrieve history of redeemed rewards for a member

This endpoint allows you to retrieve and filter rewards associated with a specific member identified by their Member ID. This endpoint retrieves a detailed history of all rewards that the member has previously redeemed. Using the provided member ID, it returns a list of rewards the member has utilized, including details such as reward names, redemption dates, usage status, and any associated metadata. This allows tracking of past reward usage and helps administrators monitor reward consumption over time. This endpoint supports various query parameters to refine the response and provide more precise data.

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

## Path parameters:

  - `memberId` (string, required)
    Unique identifier of the member whose reward history is being retrieved.
    Example: "XYZ@annexcloud.com"

## Response 200 fields (application/json):

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

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

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

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

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

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

  - `data.member_reward_status` (string)
    Displays the status of the reward.
    Example: "Awarded"

  - `data.assign_id` (string)
    Displays the unique identifier generated when assigning the reward.
    Example: "59ef1ac7-0fcf-11f0-8055-026bc940cf4b"

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

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

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

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

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

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

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

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

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

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

  - `data.reward_code` (string)
    Displays the code assigned to the member, if the reward requires a code.
    Example: "BIRTHDAY"

  - `data.code_expiration` (string)
    Displays the expiration timeline for the issued code in in YYYY-MM-DD HH:mm:ssZ format.
    Example: "2024-01-01T00:00:00Z"

  - `data.order_id` (string)
    Displays the order ID against which the reward was used.
    Example: "0987766"

  - `data.used_date` (string)
    Displays the date and time the reward was used by the member in YYYY-MM-DD HH:mm:ssZ format.
    Example: "2024-01-01T00:00:00Z"

  - `data.issuance_details` (object)
    Displays detailed information about the reward issuance.

  - `data.issuance_details.issue_date` (string)
    Displays the date and time when the reward was issued in YYYY-MM-DD HH:mm:ssZ format.
    Example: "2024-01-01T00:00:00Z"

  - `data.issuance_details.source_type` (string)
    Displays the source of reward issuance.
    Example: "Manual"

  - `data.issuance_details.source_details` (object)
    Displays additional details about the issuance.

  - `data.issuance_details.source_details.source_id` (string)
    Displays the unique identifier for the source of the reward issuance. If the reward is triggered via a journey, this field displays the journey ID. If issued manually, it displays the admin user ID.
    Example: "ADM-789"

  - `data.issuance_details.source_details.source_name` (string)
    Displays the name associated with the source of the reward issuance. If the reward is triggered via a journey, this field displays the journey name. If issued manually, it displays the admin user name.
    Example: "John Doe"

  - `data.issuance_details.notes` (string)
    Displays any additional comments or information about the assignment.
    Example: "Test rewards"

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

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

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

  - `data.collected_redemption_data` (object)
    Displays the redemption data that is collected from the member.

  - `data.collected_redemption_data.state` (string)
    Displays the state where the reward was awarded.
    Example: "Maharashtra"

  - `data.collected_redemption_data.city` (string)
    Displays the city where the reward was awarded.
    Example: "Pune"

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