---
title: "Get all point earning rules"
method: GET
path: "/api/external/point-earn-rules"
tags: ["Points & Earn Rules"]
---

# Get all point earning rules

`GET /api/external/point-earn-rules`

## Query parameters

- `includeInactive` boolean

## Headers

- `X-API-Key` string, required

## Response `200`

Successfully retrieved point earning rules

- PointEarnRuleDTO
  - `activityType` 'REGULAR' | 'REFERRAL' | 'VIP'
  - `addAdditionalPoints` boolean
  - `additionalPoints` number, double
  - `allowedCustomerTags` string
  - `allowedOrderTags` string
  - `allowedProductTags` string
  - `appliesOn` 'ONE_TIME' | 'SUBSCRIPTION' | 'BOTH'
  - `applyOnImportedCustomer` boolean
  - `autoApprovalDays` integer
  - `basePoints` number, double, required
  - `collectionData` string
  - `collectionId` integer
  - `createAt` string, date-time
  - `customerFacingIconUrl` string
  - `customerFacingLabel` string
  - `customerNotification` string, required
  - `disableForOnSellProduct` boolean
  - `disablePointsForDiscountedProduct` boolean
  - `earnLimit` integer
  - `earnType` 'STORE_CREDIT' | 'DISCOUNT_CODE' | 'POINTS'
  - `eligibleForFirstOrder` boolean
  - `enableBirthdayPromo` boolean
  - `enableInterval` boolean
  - `excludeCollections` string
  - `excludeOrderTags` string
  - `excludeProducts` string
  - `excludeVariantIds` string
  - `givePointsToGuestCustomers` boolean
  - `historicPurchaseDuration` 'NONE' | 'ALL' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_MONTH' | 'THREE_MONTH' | 'ONE_YEAR'
  - `id` integer
  - `includeShippingPoints` boolean, required
  - `includeSubtotal` boolean, required
  - `includeTax` boolean, required
  - `manuallyApprovePoints` boolean
  - `maximumPoints` integer
  - `minimumOrderValue` number, double
  - `name` string, required
  - `platformType` 'POS_ONLY' | 'ONLINE_STORE' | 'BOTH'
  - `pointBasedOn` 'QUANTITY' | 'AMOUNT_SPEND' | 'FLAT_PURCHASE'
  - `pointsProvided` number, double
  - `productData` string
  - `productId` integer
  - `promoPointsMultiplier` number, double
  - `refundNotificationLabel` string
  - `restrictCustomerTags` string
  - `restrictProductTags` string
  - `rewardAssignType` 'DYNAMIC' | 'FIXED'
  - `rewardInterval` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' | 'LIFETIME'
  - `rollBackPointsOnUnsubscribe` boolean
  - `ruleEndDate` string, date-time
  - `ruleStartDate` string, date-time
  - `serial` integer
  - `shop` string
  - `showReviewProductDetails` boolean
  - `socialUrl` string
  - `status` 'ACTIVE' | 'INACTIVE', required
  - `translations` string
  - `triggeredCount` integer
  - `type` 'PURCHASE' | 'VISIT_SHOP' | 'REFERRAL' | 'CREATE_ACCOUNT' | 'FACEBOOK_PAGE_LIKE' | 'FOLLOW_TWITTER' | 'FOLLOW_INSTAGRAM' | 'BIRTHDAY' | 'LEAVE_REVIEW' | 'SUBSCRIBE_NEWSLETTER' | 'BUY_PRODUCT' | 'BUY_PRODUCT_FROM_COLLECTION' | 'LEAVE_REVIEW_STAMPED_IO' | 'LEAVE_REVIEW_LOOX_IO' | 'LEAVE_REVIEW_JUDGE_ME' | 'LEAVE_REVIEW_PRODUCT_REVIEWS' | 'SUBSCRIPTION' | 'YOUTUBE' | 'TIKTOK' | 'OKENDO' | 'HELPFULL_PRODUCT_REVIEWS' | 'RIVYO_PRODUCT_REVIEWS' | 'REVIEWS_IO' | 'QUANTITY_BASED_POINTS' | 'SUBSCRIBE_SMS' | 'VISIT_PINTEREST' | 'AIR_REVIEWS' | 'STATIC_EARN_RULE' | 'SHARE_ON_FACEBOOK' | 'SHARE_ON_X' | 'FIXED_REWARD', required
  - `updateAt` string, date-time
  - `variantId` integer
  - `vipTierId` integer

## Other responses

- `401` — Unauthorized - Invalid or missing X-API-Key

---

[API](https://skmtc.net/appstle/apis/admin-apis.md) · [All operations](https://skmtc.net/appstle/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/appstle/admin-apis/versions/fd4af3eaa936/schema)