# Tier information against site ID and page number

This method retrieves tier details against a site ID and page number. Site ID and page number must be passed as a key to fetch all the details of the tiers.

Endpoint: GET /tierlist/all?page=1
Version: 3.0.0
Security: 

## Query parameters:

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

  - `page` (integer)
    Enter the page number to get the activities associated with that page.(Default value is 1)
    Example: 5

## Response 200 fields (application/json):

  - `siteId` (string)
    Displays the Annex Cloud site ID for the loyalty program.
    Example: "29235480"

  - `tierMethod` (string)
    Displays whether the client's tier setup is sequential or non-sequential. When a system is set up with sequential tiers, such as Tier 1, Tier 2, and Tier 3, the tiers are assigned in that order. However, a non-sequential system does not assign tiers in a sequential manner, and as a result, the assigned tier may move up from Tier 1 to Tier 3. For example, if there are 3 tier levels called Bronze (Tier1), Silver (Tier2) and Gold (Tier3). In the case of Sequential setup, the member cannot jump directly from Bronze to Gold but in the case of non-Sequential setup, the member can jump directly from Bronze to Gold if they meet the criteria.
    Example: "Sequential"

  - `tierDetail` (object)
    Displays the tier details.

  - `tierDetail.tierId` (integer)
    Displays the system generated unique tier ID.
    Example: 1592

  - `tierDetail.tierName` (string)
    Displays the tier name given while creating the tier.
    Example: "Test"

  - `tierDetail.tierLevel` (integer)
    Displays the tier level, which indicates the actual position of the tier in the hierarchy.

  - `tierDetail.tierStatus` (string)
    Displays the current status of the tier that is, active or inactive.
    Example: "active"

  - `tierDetail.tierType` (string)
    Displays the tier type selected, which indicates the points criteria of the threshold required to enter the tier.
    Example: "spent points based on calendar year"

  - `tierDetail.tierPointsExpirationType` (string)
    Displays the tier expiration type that is, ‘Rolling’ or ‘Calendar’, which indicates if the points will expire in a number of days (Rolling) or in weeks, months, or years (Calendar). If the Tier Based Points Expiration flag is enabled for the action, then all the points earned for the action will have the tier expiration date in place of original action expiration date.
    Example: "rolling"

  - `tierDetail.tierPointsExpireIn` (string)
    Displays the expiration date set for the tier. If ‘Rolling’ is selected, the result appears in days, whereas ‘Calendar’ shows the result in weeks, months or years.
    Example: "5 days"

  - `tierDetail.tierPointsExpireYearValue` (string)
    Displays the date on which the tier points value expires in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2023-01-25T23:52:18+0000"

  - `tierDetail.tierMaximumPointsLimit` (integer)
    Displays the maximum point limit for the tier. In this case Override Action Point Limit flag should be enabled.
    Example: 1

  - `tierDetail.tierMilestone` (object)
    Displays the following parameters.

  - `tierDetail.tierMilestone.tierThreshold` (integer)
    Displays the required number of points the member must earn to meet the tier threshold to enter the tier.
    Example: 200

  - `tierDetail.tierMilestone.extendedAttribute` (string)
    Displays the selected extended attributes if the extended attribute is set as a milestone for the tier.
    Example: "add the details of extended attribute as UserRole, location, uID."

  - `tierDetail.tierMilestone.actionSeries` (string)
    Displays the selected action series if an action series is set as a milestone to enter the tier.
    Example: "milestone"

  - `tierDetail.tierBenefitBracket` (object)
    Displays types of brackets set for the Tier.

  - `tierDetail.tierBenefitBracket.tierBracketType` (string)
    Displays the selected benefit bracket type such as default, standard and custom.
    Example: "default"

  - `tierDetail.tierBenefitBracket.tierPurchaseRatio` (integer)
    Displays the purchase ratio defined in the Tier, which will be applied to the member’s purchases. For example, if the purchase ratio is 2 and the purchase amount is 500, 1000 points are awarded to the member after completing the purchase.
    Example: 1

  - `tierDetail.[multibucket_name]TierPurchaseRatio` (integer)
    Displays the multibucket purchase ratio which will be applied to the member’s purchases while they are in this tier. (If Enable Multibucket Tier Purchase Ratio flag is enabled)
    Example: 2

  - `tierDetail.tierBonus` (object)
    Displays the following details.

  - `tierDetail.tierBonus.tierBonusPoints` (integer)
    Displays the number of bonus points the member earns when they achieve this tier.
    Example: 10

  - `tierDetail.tierBonus.tierBonusFrequency` (string)
    Displays the frequency at which the tier bonus is awarded. For example, only once, the first time the member enters this tier, or every time the member enters the tier.
    Example: "first time only"

  - `tierDetail.tierBonus.tierBonusExpirationType` (string)
    Displays the tier expiration type as ‘Rolling’ or ‘Calendar’.
    Example: "Rolling"

  - `tierDetail.tierBonus.tierBonusExpireIn` (string)
    Displays the expiration date set for the tier. If ‘Rolling’ is selected, the result appears in days, whereas ‘Calendar’ shows the result in weeks, months, or years.
    Example: "5 days"

  - `tierDetail.tierBonus.tierBonusPointsExpireYearValue` (integer)
    Displays the value added for Point Expiration under tier settings.

  - `tierDetail.tierRewards` (object)
    Displays the tier rewards for the tier.

  - `tierDetail.tierRewards.rewardId` (integer)
    Displays the unique ID for the reward configured in the loyalty program.
    Example: 123

  - `tierDetail.tierRewards.rewardName` (string)
    Displays the name of the reward.
    Example: "reward two"

  - `tierDetail.tierRewards.tierEligible` (string)
    Displays whether the member qualifies for the reward based on tier benefits or not.
    Example: "YES"

  - `tierDetail.tierRewards.rewardLimit` (integer)
    Displays the limit for how many times a member can claim the reward. For example, If the maximum user claim count is set to five, the reward could be claimed only five times. If the maximum user claim count is set to zero, there is no restriction on claiming rewards based on availability.
    Example: 2

  - `tierDetail.tierRewards.limitPeriod` (string)
    Displays the length of time the reward claim limit is in place. For example, if the claim limit was set to 4 and the limit period is “lifetime”, the member can only claim this reward 4 times in their lifetime with the loyalty program.
    Example: "Lifetime"

  - `pages` (string)
    Displays total number of pages associated with the tiers.
    Example: 1

  - `currentPage` (string)
    Displays the current page number containing information related to the tier.
    Example: 2


## Response 400 fields

## Response 404 fields

## Response 405 fields