Skip to main content
GET
/
v1
/
loyalties
/
{campaignId}
/
tiers
/
{loyaltyTierId}
Get Loyalty Tier
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/tiers/{loyaltyTierId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "ltr_7rVIPlPzdSFwpnbCcUXgwzH2",
  "name": "Tier 1 - Top",
  "campaign_id": "camp_fkZ28pe7DUAEmmabofkxHI8N",
  "metadata": {
    "has_funds": true
  },
  "created_at": "2022-11-09T06:26:54.797Z",
  "updated_at": "2022-11-25T11:27:58.578Z",
  "earning_rules": {
    "ern_95aq3JaE5A8xzHjoJPYNRqXZ": {
      "type": "MULTIPLY",
      "multiplier": 3
    },
    "ern_AdlWO2yt6b6llWsibIdiRXVE": {
      "type": "MULTIPLY",
      "multiplier": 5
    },
    "ern_HnRXyJHoj3E79r3KUWhgMgtD": {
      "type": "MULTIPLY",
      "multiplier": 3
    },
    "ern_raVUcdXruvXGuzm682ESrAzt": {
      "type": "CUSTOM",
      "points": 200
    }
  },
  "rewards": {
    "rewa_Or6gWZ5ASuGkBLjOf0IyiD4k": {
      "type": "CUSTOM",
      "points": 300
    }
  },
  "config": {
    "points": {
      "from": 500,
      "to": 1000
    }
  },
  "points": {
    "from": 500,
    "to": 1000
  },
  "object": "loyalty_tier"
}

Authorizations

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

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
campaignId
string
required

Unique loyalty campaign ID or name.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

​
loyaltyTierId
string
required

Unique loyalty tier ID.

Example:

"promo_2EnAik6Jt7dKTOMkRTIgEjZH"

Response

200 - application/json

Returns a loyalty tier object.

Response body schema for GET v1/loyalties/{campaignId}/tiers/{loyaltyTierId}.

​
name
string
required

Loyalty Tier name.

​
points
object
required

Defines range of loyalty tier in points.

​
id
string
required

Unique loyalty tier ID.

​
campaign_id
string
required

Unique parent campaign ID.

​
metadata
object
required

The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.

​
created_at
string<date-time>
required

Timestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.

​
config
object
required

Defines loyalty tier range in points.

​
object
enum<string>
default:loyalty_tier
required

The type of the object represented by JSON. This object stores information about the loyalty.

Available options:
loyalty_tier
​
earning_rules
object

Contains a list of earning rule IDs and their points mapping for the given earning rule.

​
rewards
object

Contains a list of reward IDs and their points mapping for the given reward.

​
updated_at
string<date-time> | null

Timestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.

​
expiration
Loyalty Tier Expiration · object

Defines loyalty tier expiration date.