Tier Structures

Get tier structure

Changed on Oct 14, 2026

<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

Returns a single tier structure by its ID.

A successful call records no activity.

get/v2/loyalties/tier-structures/{tierStructureId}

Request

Base URL
https://api.voucherify.io
Auth
- API key in header X-App-Id and API key in header X-App-Token
- or HTTP bearer
TypeScript
https://skmtc.dev/voucherifyio/apis/voucherify-loyalty-v2-api/docs/v2/loyalties/tier-structures/:tierStructureId/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

The tier structure.

metadataobject required

Free-form key/value object holding custom attributes. Defaults to {}.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time nullable required

Last update timestamp (ISO 8601), or null if never updated.

idstring required

Unique tier structure identifier.

namestring required

Display name of the tier structure.

type'POINT_BALANCE' | 'POINT_EARNED' required

Tier qualification tracking model.

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DELETED' required

Current lifecycle status of the tier structure.

object'tier_structure' required

Object type discriminator. Always tier_structure.

Changes

Oct 14, 2026v26a418ac8b7b1 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  deleted the path request parameter tierStructureId
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added to the response body allOf list for the response status
Oct 14, 2026v21e528b6c500d Revision changes
- breaking
  added the new path request parameter tierStructureId
- info
  removed from the response body allOf list for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (11 revisions)

Get tier structure

Request

Response 200OK

Changes

Response