TAtalon
Loyalty

List loyalty programs

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List the loyalty programs of the account.

get/v1/loyalty_programs

Request

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 139,
      "created": "2020-06-10T09:05:27.993483Z",
      "title": "Point collection",
      "description": "Customers collect 10 points per 1$ spent",
      "subscribedApplications": [
        132,
        97
      ],
      "defaultValidity": "2W_U",
      "defaultPending": "immediate",
      "usersPerCardLimit": 111,
      "sandbox": true,
      "tierCycleStartDate": "2021-09-12T10:12:42Z",
      "tiersExpireIn": "27W_U",
      "cardCodeSettings": {
        "validCharacters": [
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "H",
          "I",
          "J",
          "K",
          "L",
          "M",
          "N",
          "O",
          "P",
          "Q",
          "R",
          "S",
          "T",
          "U",
          "V",
          "W",
          "X",
          "Y",
          "Z",
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9"
        ],
        "couponPattern": "SUMMER-####-####"
      },
      "accountID": 1,
      "name": "my_program",
      "tiers": [
        {
          "name": "Gold",
          "minPoints": 300,
          "id": 3,
          "created": "2021-06-10T09:05:27.993483Z",
          "programID": 139
        },
        {
          "name": "Silver",
          "minPoints": 200,
          "id": 2,
          "created": "2021-06-10T09:04:59.355258Z",
          "programID": 139
        },
        {
          "name": "Bronze",
          "minPoints": 100,
          "id": 1,
          "created": "2021-06-10T09:04:39.355258Z",
          "programID": 139
        }
      ],
      "timezone": "Europe/Berlin",
      "cardBased": true,
      "canUpdateTiers": true,
      "canUpdateTierExpirationPolicy": true,
      "canUpgradeToAdvancedTiers": true,
      "canUpdateSubledgers": true
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.