Skip to main content
GET
/
v1
/
campaigns
/
{campaignId}
Get Campaign
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "camp_JlsseNSDO7l4neFtev6p6945",
  "name": "$20 OFF Entire Order",
  "campaign_type": "DISCOUNT_COUPONS",
  "type": "AUTO_UPDATE",
  "voucher": {
    "type": "DISCOUNT_VOUCHER",
    "discount": {
      "type": "AMOUNT",
      "amount_off": 2000,
      "effect": "APPLY_TO_ORDER"
    },
    "redemption": {
      "quantity": null
    },
    "code_config": {
      "length": 8,
      "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
      "pattern": "########",
      "prefix": "$20OFFORDER-"
    },
    "is_referral_code": false
  },
  "auto_join": false,
  "join_once": false,
  "use_voucher_metadata_schema": true,
  "vouchers_count": 1,
  "active": true,
  "metadata": {},
  "created_at": "2022-07-11T09:43:36.057Z",
  "creation_status": "DONE",
  "vouchers_generation_status": "DONE",
  "protected": false,
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [],
    "total": 0
  },
  "category_id": null,
  "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>
required
Available options:
LOYALTY_PROGRAM,
GIFT_VOUCHERS,
DISCOUNT_COUPONS,
PROMOTION,
REFERRAL_PROGRAM
type
enum<string>
required
Available options:
AUTO_UPDATE,
STATIC,
STANDALONE
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
referral_program
object
loyalty_tiers_expiration
object
access_settings_assignments
object
promotion
object
validation_rules_assignments
object