List Tiers

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Returns a paginated, cursor-based list of tiers belonging to the specified tier structure.

GET /v2/loyalties/tier-structures/{id}/tiers

List Tiers

cURL

curl --request GET \
  --url https://api.voucherify.io/v2/loyalties/tier-structures/{id}/tiers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "tier_structure_id": "<string>",
      "name": "<string>",
      "downgrade": {},
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "object": "tier",
      "qualification_rules": {
        "min_value": 1,
        "max_value": 1,
        "segment": {
          "id": "<string>"
        }
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "object": "list",
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

id · string · required

Unique tier structure identifier.

Query Parameters

limit · integer · default: 10

Maximum number of results to return (1-100).

Required range: 1 <= x <= 100

order · enum<string>[]

Sort order. Prefix with - for descending. Default: -created_at.

Available options: created_at, -created_at, name, -name

cursor · string

Cursor for pagination. Obtained from a previous list response.

Response

200

application/json

List of tiers

data · object[] · required

Show child attributes

object · enum<string> · required

Available options: list

cursor · object | null

Cursor for fetching the next page of results.

Show child attributes