Skip to main content
GET
/
v1
/
loyalties
/
{campaignId}
Get Loyalty Campaign
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
  "name": "Loyalty Campaign - Tiers - 1",
  "campaign_type": "LOYALTY_PROGRAM",
  "type": "AUTO_UPDATE",
  "voucher": {
    "type": "LOYALTY_CARD",
    "loyalty_card": {
      "points": 0
    },
    "redemption": {
      "quantity": null
    },
    "code_config": {
      "length": 8,
      "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
      "pattern": "########",
      "prefix": "LT1-",
      "initial_count": 1
    },
    "is_referral_code": false,
    "start_date": "2022-11-01T00:00:00.000Z"
  },
  "auto_join": false,
  "join_once": false,
  "use_voucher_metadata_schema": true,
  "start_date": "2022-11-01T00:00:00.000Z",
  "validity_day_of_week": [
    1,
    2,
    3,
    4,
    5,
    6
  ],
  "vouchers_count": 3,
  "active": true,
  "metadata": {},
  "created_at": "2022-11-09T06:26:52.985Z",
  "updated_at": "2022-11-10T08:54:46.136Z",
  "category": "Eighth",
  "creation_status": "DONE",
  "vouchers_generation_status": "DONE",
  "protected": false,
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [],
    "total": 0
  },
  "category_id": "cat_0b8b5a427a0283c854",
  "categories": [
    {
      "id": "cat_0b8b5a427a0283c854",
      "name": "Eighth",
      "hierarchy": 8,
      "created_at": "2022-08-16T11:45:54.171Z",
      "object": "category"
    }
  ],
  "loyalty_tiers_expiration": {
    "qualification_type": "BALANCE",
    "start_date": {
      "type": "IMMEDIATE"
    },
    "expiration_date": {
      "type": "CUSTOM",
      "extend": "P3M",
      "rounding": {
        "type": "MONTH",
        "strategy": "END"
      }
    }
  },
  "object": "campaign"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

campaignId
string
required
Example:

Response

id
string
required
Example:
name
string
required
campaign_type
enum<string>
default:LOYALTY_PROGRAM
required
Available options:
LOYALTY_PROGRAM
type
enum<string>
required
Available options:
AUTO_UPDATE,
STATIC
auto_join
boolean
required
join_once
boolean
required
use_voucher_metadata_schema
boolean
required
created_at
string<date-time>
required
Example:
creation_status
enum<string>
required
Available options:
DONE,
IN_PROGRESS,
FAILED,
DRAFT,
MODIFYING
vouchers_generation_status
enum<string>
required
Available options:
DONE,
IN_PROGRESS,
FAILED,
DRAFT,
MODIFYING
protected
boolean
required
category_id
string | null
required
Example:
categories
Category · object[]
required
object
string
default:campaign
required
description
string
voucher
object
validity_timeframe
object
validity_day_of_week
enum<integer>[]
validity_hours
object
activity_duration_after_publishing
string
vouchers_count
integer
start_date
string<date-time>
Example:
expiration_date
string<date-time>
Example:
active
boolean
metadata
object
updated_at
string<date-time>
Example:
category
string
readonly
boolean
loyalty_tiers_expiration
object
validation_rules_assignments
object
access_settings_assignments
object