v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Loyalty Programs

Retrieves all the active loyalty programs of the org.

get/organization/programs

Response

200

Example response

{
  "data": [
    {
      "programId": 622,
      "programName": "CLIENT_MERGEDefaultProgram",
      "pointsToCurrencyRatio": 0.111,
      "programDescription": "Default program for CLIENT_MERGE",
      "partnerPrograms": [
        {
          "partnerProgramId": 5,
          "partnerProgramName": "1stProgram",
          "partnerProgramDescription": "1stProgram",
          "partnerProgramTiers": [
            {
              "tierNumber": 1,
              "tierName": "1stSlab"
            }
          ],
          "pointsExchangeRate": 1,
          "partnerProgramType": "EXTERNAL",
          "tierBased": true
        }
      ],
      "default": true
    }
  ]
}