# To retrieve point details for a member

This method retrieves point details associated with a member’s ID. The member needs to use their ID as a key to fetch all the points details.

Endpoint: GET /points/{{memberId}}
Version: 3.0.0
Security: 

## Path parameters:

  - `memberId` (string, required)
    Enter the unique ID of the member.
    Example: "user@domain.com"

## Response 200 fields (application/json):

  - `siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 146031180

  - `id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `availablePoints` (integer)
    Displays the number of available points in the member’s account.
    Example: 6620

  - `usedPoints` (integer)
    Displays the total number of points deducted from the member’s account. This excludes points debited as part of Action ID 192, ensuring clarity and precise tracking of point usage.
    Example: 2000

  - `negativePoints` (integer)
    Displays the total number of negative points in the member’s account.
    Example: -50

  - `expiredPoints` (integer)
    Displays the total number of points that have expired from the member's account. This includes points associated with Action ID 106 as well as points debited under Action ID 192 - Action Debit Points, both categorized as expired.

  - `lifetimePoints` (integer)
    Displays the number of points the member has earned in their lifetime with the loyalty program.
    Example: 8620

  - `earnedPointsPeriod` (string)
    Displays the period during which points are earned by the member. For example, Anniversary Year, calendar year, quarter, semester. (Displays only when earned points display flag is enabled in the configuration).
    Example: "anniversary year"

  - `earnedPoints` (integer)
    Displays the total number of points earned by the member within the selected time period.
    Example: 640

  - `holdPoints` (integer)
    Displays the total number of points on hold in the member’s account.

  - `usedPointsOnReward` (integer)
    Displays the total number of points used by the member on rewards.

  - `pointsToExpire` (integer)
    Displays the total number of expired points, indicating that the member had not used these points within the specified date range.
    Example: 10

  - `pointsToNextTier` (integer)
    Displays the number of points  needed for the member to achieve the next tier.

  - `spendToNextTier` (integer)
    Displays the amount that the member needs to spend to achieve the next tier.

  - `pointsToExpireDate` (string)
    Displays the date on which the points will expire in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2024-04-28T06:02:06+0000"

  - `totalSpent` (integer)
    Displays the total dollar amount the member has spent.
    Example: 375

  - `rewardDenomination` (integer)
    Displays the denomination value associated with the reward.
    Example: 500

  - `creditsToCurrencyRatio` (integer)
    Displays the credit-to-currency ratio defined by the admin. Multiplying this ratio by the member's available points results in the total currency value of the available points.
    Example: 110

  - `creditsToCurrencyValue` (string)
    Displays the total currency value after multiplying the available points with the credit-to-currency ratio, rounded to the defined decimal place. Note - Set the ‘Credit to Currency Value Up To’ configuration in the ADR to 2 decimal places. This ensures a consistent response format by always returning the value as a string data type.
    Example: 10.5

  - `ytdCreditPoints` (integer)
    Displays the total number of points credited to the member’s account from the beginning of the year up to the current date.
    Example: 8620

  - `ytdDebitPoints` (integer)
    Displays the total number of points debited from the member’s account from the beginning of the year up to the current date.
    Example: 2000

  - `multiBucketsData` (object)
    Displays an array of all multi- bucket details with the following fields.

  - `multiBucketsData.bucketName` (object)
    Displays an array of all multi- bucket names.

  - `multiBucketsData.bucketName.available[bucketName]` (integer)
    Displays the number of points available in the member’s account within the additional point bucket.
    Example: 100

  - `multiBucketsData.bucketName.lifetime[bucketName]` (integer)
    Displays the number of points the member has earned towards the additional point bucket in their lifetime with the loyalty program.
    Example: 200

  - `multiBucketsData.bucketName.used[bucketName]` (integer)
    Displays the number of points used by the member from the additional point bucket.
    Example: 300

  - `multiBucketsData.bucketName.negative[bucketName]` (integer)
    Displays the number of negative points in the member’s account in the additional point bucket.

  - `multiBucketsData.bucketName.hold[bucketName]` (integer)
    Displays the number of points on hold from the additional point bucket.

  - `multiBucketsData.bucketName.expired[bucketName]` (integer)
    Displays the number of points from the additional point bucket that have expired.
    Example: 100

  - `multiBucketsData.bucketName.ToExpire[bucketName]` (integer)
    Displays the total number of points that are next to expire in the additional point bucket.
    Example: 500

  - `multiBucketsData.bucketName.ToExpireDate[bucketName]` (string)
    Displays the date on which the points will expire in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2020-10-30T05:30:00+0000"

  - `multiBucketsData.bucketName.ToNextTier[bucketName]` (integer)
    Displays the number of points required to reach the next tier associated with the additional point bucket.

  - `multiBucketsData.bucketName.tier[bucketName]` (object)
    Displays an array of all multi-bucket names.

  - `multiBucketsData.bucketName.tier[bucketName].availableTier[bucketName]` (integer)
    Displays the number of available tier points in the member’s account.
    Example: 100

  - `multiBucketsData.bucketName.tier[bucketName].lifetimeTier[bucketName]` (integer)
    Displays the number of tier points the member has earned in their lifetime with the loyalty program.
    Example: 500

  - `multiBucketsData.bucketName.tier[bucketName].usedTier[bucketName]` (integer)
    Displays the number of used tier points.
    Example: 100

  - `multiBucketsData.bucketName.tier[bucketName].negativeTier[bucketName]` (integer)
    Displays the number of negative tier points in the member’s account.

  - `multiBucketsData.bucketName.tier[bucketName].holdTier[bucketName]` (integer)
    Displays the number of tier points on hold.
    Example: 800

  - `multiBucketsData.bucketName.tier[bucketName].expiredTier[bucketName]` (integer)
    Displays the total number of tier points that have expired.
    Example: 100

  - `multiBucketsData.bucketName.tier[bucketName].tier[bucketName]ToExpire` (integer)
    Displays the number of tier points that are next to expire from the member’s account.
    Example: 500

  - `multiBucketsData.bucketName.tier[bucketName].tier[bucketName]ToExpireDate` (string)
    Displays the date on which the tier points will expire in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2020-10-30T05:30:00+0000"

  - `multiBucketsData.bucketName.tier[bucketName].toNextTier[bucketName]` (integer)
    Displays the number of points that are required to reach to next tier associated with the tier bucket.

  - `availableRedemptionPoints` (integer)
    Displays the total number of available points for redemption in the member’s account.

  - `usedRedemptionPoints` (integer)
    Displays the total number of points used for redemption in the member’s account.

  - `groupDetails` (object)
    Displays the following information about the group with which the member is associated.

  - `groupDetails.groupId` (string)
    Displays the unique group ID generated during group creation.
    Example: "91"

  - `groupDetails.groupName` (string)
    Displays the name of the group to which the member belongs.
    Example: "Loyalty Circle"

  - `groupDetails.groupAvailablePoints` (string)
    Displays the total available points for the group. It is the cumulative points of the group members.
    Example: "500"

  - `groupDetails.groupLifetimePoints` (string)
    Displays the total number of group points accumulated throughout its time in the loyalty program.
    Example: "100"

  - `groupDetails.groupUsedPoints` (string)
    Displays the number of points used from the group account.
    Example: "200"

  - `groupDetails.groupExpiredPoints` (string)
    Displays the number of expired points from the group account.
    Example: "0"


## Response 400 fields

## Response 403 fields

## Response 404 fields

## Response 405 fields

## Response 422 fields